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/README.md b/.devcontainer/README.md new file mode 100644 index 000000000..a71936168 --- /dev/null +++ b/.devcontainer/README.md @@ -0,0 +1,38 @@ +# 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.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/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json new file mode 100644 index 000000000..cdd65d220 --- /dev/null +++ b/.devcontainer/devcontainer.json @@ -0,0 +1,17 @@ +{ + "name": "Puppet Development Kit (Community)", + "dockerFile": "Dockerfile", + + "settings": { + "terminal.integrated.profiles.linux": { + "bash": { + "path": "bash" + } + } + }, + + "extensions": [ + "puppet.puppet-vscode", + "rebornix.Ruby" + ] +} diff --git a/.fixtures.yml b/.fixtures.yml new file mode 100644 index 000000000..b25e8c459 --- /dev/null +++ b/.fixtures.yml @@ -0,0 +1,8 @@ +fixtures: + repositories: + 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 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 diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 000000000..9032a014a --- /dev/null +++ b/.gitattributes @@ -0,0 +1,5 @@ +*.rb eol=lf +*.erb eol=lf +*.pp eol=lf +*.sh eol=lf +*.epp eol=lf 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 diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 000000000..2cdfc30f1 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,19 @@ +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" + with: + flags: "--nightly" + secrets: "inherit" 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" diff --git a/.github/workflows/nightly.yml b/.github/workflows/nightly.yml new file mode 100644 index 000000000..5a39a47c7 --- /dev/null +++ b/.github/workflows/nightly.yml @@ -0,0 +1,18 @@ +name: "nightly" + +on: + schedule: + - cron: "0 0 * * *" + 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" + with: + flags: "--nightly" + secrets: "inherit" diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 000000000..4b3b80fc8 --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,9 @@ +name: "Publish module" + +on: + workflow_dispatch: + +jobs: + release: + uses: "puppetlabs/cat-github-actions/.github/workflows/module_release.yml@main" + secrets: "inherit" diff --git a/.github/workflows/release_prep.yml b/.github/workflows/release_prep.yml new file mode 100644 index 000000000..bb0b7acce --- /dev/null +++ b/.github/workflows/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/.gitignore b/.gitignore index 2e3ca630f..2803e566b 100644 --- a/.gitignore +++ b/.gitignore @@ -1,8 +1,35 @@ -pkg/ +.git/ +.*.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/ +/.vendor/ +/convert_report.txt +/update_report.txt .DS_Store -metadata.json -coverage/ -spec/fixtures/ -Gemfile.lock -.bundle/ -vendor/bundle/ +.project +.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/.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..9d89d9faa --- /dev/null +++ b/.gitpod.yml @@ -0,0 +1,9 @@ +image: + file: .gitpod.Dockerfile + +tasks: + - init: pdk bundle install + +vscode: + extensions: + - puppet.puppet-vscode@1.2.0:f5iEPbmOj6FoFTOV6q8LTg== diff --git a/.pdkignore b/.pdkignore new file mode 100644 index 000000000..84684be63 --- /dev/null +++ b/.pdkignore @@ -0,0 +1,51 @@ +.git/ +.*.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/ +/.vendor/ +/convert_report.txt +/update_report.txt +.DS_Store +.project +.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 +/.github/ +/.gitignore +/.pdkignore +/.puppet-lint.rc +/Rakefile +/rakelib/ +/.rspec +/..yml +/.yardopts +/spec/ +/.vscode/ +/.sync.yml +/.devcontainer/ diff --git a/.project b/.project deleted file mode 100644 index 4e2c033ac..000000000 --- a/.project +++ /dev/null @@ -1,23 +0,0 @@ - - - stdlib - - - - - - org.cloudsmith.geppetto.pp.dsl.ui.modulefileBuilder - - - - - org.eclipse.xtext.ui.shared.xtextBuilder - - - - - - org.cloudsmith.geppetto.pp.dsl.ui.puppetNature - org.eclipse.xtext.ui.shared.xtextNature - - diff --git a/.puppet-lint.rc b/.puppet-lint.rc new file mode 100644 index 000000000..9e15c6e01 --- /dev/null +++ b/.puppet-lint.rc @@ -0,0 +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/.rspec b/.rspec index 7ab5f55c5..16f9cdb01 100644 --- a/.rspec +++ b/.rspec @@ -1,4 +1,2 @@ --color ---format -progress ---backtrace +--format documentation diff --git a/.rubocop.yml b/.rubocop.yml new file mode 100644 index 000000000..47b1aadbe --- /dev/null +++ b/.rubocop.yml @@ -0,0 +1,731 @@ +--- +require: +- rubocop-performance +- rubocop-rspec +AllCops: + NewCops: enable + DisplayCopNames: true + TargetRubyVersion: 3.1 + Include: + - "**/*.rb" + Exclude: + - bin/* + - ".vendor/**/*" + - "**/Gemfile" + - "**/Rakefile" + - pkg/**/* + - spec/fixtures/**/* + - vendor/**/* + - "**/Puppetfile" + - "**/Vagrantfile" + - "**/Guardfile" +inherit_from: ".rubocop_todo.yml" +Layout/LineLength: + 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 +RSpec/DescribeSymbol: + Exclude: + - spec/unit/facter/**/*.rb +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: + 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 +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/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 +RSpec/MessageSpies: + EnforcedStyle: receive +Style/Documentation: + Exclude: + - lib/puppet/parser/functions/**/* + - 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/DuplicateMatchPattern: + 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/DataInheritance: + 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/RedundantLineContinuation: + 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 new file mode 100644 index 000000000..7eb42c4b1 --- /dev/null +++ b/.rubocop_todo.yml @@ -0,0 +1,33 @@ +# This configuration was generated by +# `rubocop --auto-gen-config` +# 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: 1 +# This cop supports safe autocorrection (--autocorrect). +Layout/RescueEnsureAlignment: + Exclude: + - 'lib/puppet/parser/functions/any2bool.rb' + +# Offense count: 3 +# This cop supports safe autocorrection (--autocorrect). +Lint/RedundantCopDisableDirective: + Exclude: + - 'lib/puppet/functions/deprecation.rb' + - 'spec/functions/loadjson_spec.rb' + +# Offense count: 3 +# Configuration parameters: AllowComments, AllowNil. +Lint/SuppressedException: + Exclude: + - 'lib/puppet/functions/stdlib/merge.rb' + - 'lib/puppet/parser/functions/has_interface_with.rb' + +# Offense count: 257 +# Configuration parameters: EnforcedStyle, IgnoreSharedExamples. +# SupportedStyles: always, named_only +RSpec/NamedSubject: + Enabled: false diff --git a/.sync.yml b/.sync.yml new file mode 100644 index 000000000..dedc937aa --- /dev/null +++ b/.sync.yml @@ -0,0 +1,27 @@ +--- +".gitlab-ci.yml": + delete: true +".rubocop.yml": + include_todos: true +appveyor.yml: + delete: true +Rakefile: + changelog_max_issues: 500 + +spec/spec_helper.rb: + mock_with: ":rspec" + coverage_report: true +.gitpod.Dockerfile: + unmanaged: false +.gitpod.yml: + unmanaged: false +.github/workflows/auto_release.yml: + unmanaged: false +.github/workflows/ci.yml: + unmanaged: false +.github/workflows/nightly.yml: + 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 8334d4287..000000000 --- a/.travis.yml +++ /dev/null @@ -1,25 +0,0 @@ -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: - allow_failures: - - rvm: 2.0.0 - - rvm: ruby-head - include: - - rvm: 1.8.7 - env: PUPPET_GEM_VERSION="~> 2.7" -notifications: - email: false - webhooks: - urls: - - https://puppet-dev-community.herokuapp.com/event/travis-ci/ - on_success: always - on_failure: always - on_start: yes diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 000000000..6da8d472f --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,6 @@ +{ + "recommendations": [ + "puppet.puppet-vscode", + "Shopify.ruby-lsp" + ] +} 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/CHANGELOG b/CHANGELOG deleted file mode 100644 index e1a095f63..000000000 --- a/CHANGELOG +++ /dev/null @@ -1,278 +0,0 @@ -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 diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 000000000..6f650b7a7 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,1263 @@ + +# 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). + +## [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) + +### 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) + +### 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) + +### 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) + +### Added + +- Modernise `fqdn_rotate` function [#1341](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1341) ([alexjfisher](https://github.com/alexjfisher)) + +## [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) + +### 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) + +### 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) + +### 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)) +- 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 + +[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)) +- 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)) + +### 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)) +- 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) + +### 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) + +### 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) + +### 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) + +### 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) + +### 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) + +### 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) + +### 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) ([LadyNamedLaura](https://github.com/LadyNamedLaura)) + +## [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)) + +## [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)) + +## [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) + +### 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) + +### 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-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)) + +### 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)) + +## [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)) + +### 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) + +### 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) + +### 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-22 + +[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)) + +## [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)) + +### 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-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)) + +### 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)) +- (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](https://github.com/puppetlabs/puppetlabs-stdlib/tree/5.0.0) - 2018-08-22 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.25.1...5.0.0) + +### Added + +- (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 + +- 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)) + +## [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) + +## [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) + +### 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)) +- FixToAccountForVersionChange [#867](https://github.com/puppetlabs/puppetlabs-stdlib/pull/867) ([david22swan](https://github.com/david22swan)) + +## [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) + +### Fixed + +- (MODULES-6216) - Fix type3x function in stdlib [#861](https://github.com/puppetlabs/puppetlabs-stdlib/pull/861) ([pmcmaw](https://github.com/pmcmaw)) + +## [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) + +## [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) + +### Fixed + +- Fixes a minor typo [#845](https://github.com/puppetlabs/puppetlabs-stdlib/pull/845) ([jbondpdx](https://github.com/jbondpdx)) + +## [4.21.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.21.0) - 2017-11-03 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.20.0...4.21.0) + +### 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 + +- 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)) +- (maint) Fix example syntax [#829](https://github.com/puppetlabs/puppetlabs-stdlib/pull/829) ([binford2k](https://github.com/binford2k)) +- 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)) +- 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 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.19.0...4.20.0) + +### Added + +- (MODULES-5546) add check for pw_hash [#810](https://github.com/puppetlabs/puppetlabs-stdlib/pull/810) ([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) + +## [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 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)) + +### Fixed + +- MODULES-5440 fix upper bound for puppet [#803](https://github.com/puppetlabs/puppetlabs-stdlib/pull/803) ([tphoney](https://github.com/tphoney)) +- (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)) +- (MODULES-5003) file_line fix all broken lines [#788](https://github.com/puppetlabs/puppetlabs-stdlib/pull/788) ([tphoney](https://github.com/tphoney)) +- (MODULES-5113) Make line support Sensitive [#786](https://github.com/puppetlabs/puppetlabs-stdlib/pull/786) ([reidmv](https://github.com/reidmv)) +- 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)) + +## [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) + +### Fixed + +- (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)) + +## [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) + +### 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 + +- (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)) +- (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)) +- Ruby 1.8 doesn't support open_args [#758](https://github.com/puppetlabs/puppetlabs-stdlib/pull/758) ([sathieu](https://github.com/sathieu)) +- [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)) + +## [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) + +### Added + +- (FM-6051) Adds comments to warn for UTF8 incompatibility [#741](https://github.com/puppetlabs/puppetlabs-stdlib/pull/741) ([HelenCampbell](https://github.com/HelenCampbell)) +- Addition of new length function [#736](https://github.com/puppetlabs/puppetlabs-stdlib/pull/736) ([HelenCampbell](https://github.com/HelenCampbell)) +- (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 + +- 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)) +- 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)) + +## [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) + +### Added + +- Implement beaker-module_install_helper [#713](https://github.com/puppetlabs/puppetlabs-stdlib/pull/713) ([wilson208](https://github.com/wilson208)) +- Addition of compat hash type for deprecation [#708](https://github.com/puppetlabs/puppetlabs-stdlib/pull/708) ([HelenCampbell](https://github.com/HelenCampbell)) +- add ubuntu xenial to metadata [#705](https://github.com/puppetlabs/puppetlabs-stdlib/pull/705) ([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)) + +## [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) + +### Added + +- (MODULES-3829) Add tests for ensure_resources [#697](https://github.com/puppetlabs/puppetlabs-stdlib/pull/697) ([HAIL9000](https://github.com/HAIL9000)) +- 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)) +- Fix spec failures on puppet 4.8 [#689](https://github.com/puppetlabs/puppetlabs-stdlib/pull/689) ([DavidS](https://github.com/DavidS)) +- (MODULES-3829) Use .dup to duplicate classes for modification. [#687](https://github.com/puppetlabs/puppetlabs-stdlib/pull/687) ([MG2R](https://github.com/MG2R)) +- (MODULES-3980) Fix ipv4 regex validator [#680](https://github.com/puppetlabs/puppetlabs-stdlib/pull/680) ([DavidS](https://github.com/DavidS)) + +## [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) + +## [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) + +### 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 + +- (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)) +- (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)) +- 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)) +- MODULES-3699 Deprecation spec fix 2 [#646](https://github.com/puppetlabs/puppetlabs-stdlib/pull/646) ([eputnam](https://github.com/eputnam)) +- Fix markdown indentation [#631](https://github.com/puppetlabs/puppetlabs-stdlib/pull/631) ([smortex](https://github.com/smortex)) +- Fix str2bool error message [#626](https://github.com/puppetlabs/puppetlabs-stdlib/pull/626) ([LoicGombeaud](https://github.com/LoicGombeaud)) +- (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)) +- 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) + +### Added + +- Add support for regular expressions to delete [#591](https://github.com/puppetlabs/puppetlabs-stdlib/pull/591) ([jyaworski](https://github.com/jyaworski)) +- Add validate_email_address function [#583](https://github.com/puppetlabs/puppetlabs-stdlib/pull/583) ([jyaworski](https://github.com/jyaworski)) +- Add check if Gem is defined [#579](https://github.com/puppetlabs/puppetlabs-stdlib/pull/579) ([sulaweyo](https://github.com/sulaweyo)) +- 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)) +- 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)) +- Add test for basename on path with scheme [#567](https://github.com/puppetlabs/puppetlabs-stdlib/pull/567) ([alechenninger](https://github.com/alechenninger)) + +### 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)) +- (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 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.10.0...4.11.0) + +### Added + +- 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)) +- Allow package_provider fact to resolve on PE 3.x [#561](https://github.com/puppetlabs/puppetlabs-stdlib/pull/561) ([DavidS](https://github.com/DavidS)) +- 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) + +### Added + +- (#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) + +### 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)) +- (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)) +- 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)) +- 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 load module metadata [#537](https://github.com/puppetlabs/puppetlabs-stdlib/pull/537) ([cmurphy](https://github.com/cmurphy)) +- 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)) + +## [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) + +### Added + +- 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)) +- (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)) + +### 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)) + +### Fixed + +- Fix extraneous end [#501](https://github.com/puppetlabs/puppetlabs-stdlib/pull/501) ([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)) +- 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) + +### Added + +- 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)) + +### Fixed + +- (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)) +- catch and rescue from looking up non-existent facts [#479](https://github.com/puppetlabs/puppetlabs-stdlib/pull/479) ([mklette](https://github.com/mklette)) +- 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)) +- 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)) +- (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)) +- 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)) +- Fix pw_hash() on JRuby < 1.7.17 [#446](https://github.com/puppetlabs/puppetlabs-stdlib/pull/446) ([elyscape](https://github.com/elyscape)) +- 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)) +- 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 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.5.1...4.6.0) + +### 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 + +- Fix the 4.6.0 release date [#438](https://github.com/puppetlabs/puppetlabs-stdlib/pull/438) ([hunner](https://github.com/hunner)) +- 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)) +- 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)) +- Fix issue with 1.8.7 and upcase [#418](https://github.com/puppetlabs/puppetlabs-stdlib/pull/418) ([cyberious](https://github.com/cyberious)) +- 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)) +- (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-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)) + +## [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) + +### 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)) +- 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)) +- Fix bad check in test [#389](https://github.com/puppetlabs/puppetlabs-stdlib/pull/389) ([underscorgan](https://github.com/underscorgan)) +- (MODULES-1582) File location placeholder [#377](https://github.com/puppetlabs/puppetlabs-stdlib/pull/377) ([petems](https://github.com/petems)) +- 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) + +### Added + +- 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)) +- 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)) + +## [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) + +### 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)) +- 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)) +- 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)) +- 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)) +- 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)) +- 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)) +- Fix strict_variables = true [#303](https://github.com/puppetlabs/puppetlabs-stdlib/pull/303) ([bobtfish](https://github.com/bobtfish)) + +## [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) + +### Fixed + +- 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) + +### Added + +- AIX has no facter network support [#296](https://github.com/puppetlabs/puppetlabs-stdlib/pull/296) ([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)) +- 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)) +- 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)) +- (FM-1587) Fix test issues on solaris 10 [#276](https://github.com/puppetlabs/puppetlabs-stdlib/pull/276) ([hunner](https://github.com/hunner)) + +## [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) + +### 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 + +- 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)) + +## [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) + +## [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) + +### Added + +- Adding more spec coverage [#247](https://github.com/puppetlabs/puppetlabs-stdlib/pull/247) ([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)) +- 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)) +- hash example has misplaced comas [#221](https://github.com/puppetlabs/puppetlabs-stdlib/pull/221) ([jtreminio](https://github.com/jtreminio)) + +## [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) + +### Added + +- (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)) +- (#23381) add is_bool() function [#211](https://github.com/puppetlabs/puppetlabs-stdlib/pull/211) ([jhoblitt](https://github.com/jhoblitt)) +- 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)) +- (#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)) +- delete_undef_values function fix bug #20681 [#184](https://github.com/puppetlabs/puppetlabs-stdlib/pull/184) ([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)) +- 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)) +- 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)) +- ensure_resource: fix documentation typo [#165](https://github.com/puppetlabs/puppetlabs-stdlib/pull/165) ([bootc](https://github.com/bootc)) +- Trivial documentation fix for upcase function. [#157](https://github.com/puppetlabs/puppetlabs-stdlib/pull/157) ([rohanrns](https://github.com/rohanrns)) + +## [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) + +### 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)) + +## [4.0.2](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.0.2) - 2013-04-12 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.0.1...4.0.2) + +### Added + +- adds compatibility matrix [#144](https://github.com/puppetlabs/puppetlabs-stdlib/pull/144) ([ghoneycutt](https://github.com/ghoneycutt)) + +## [4.0.1](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.0.1) - 2013-04-11 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/4.0.0...4.0.1) + +## [4.0.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/4.0.0) - 2013-04-11 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/3.2.0...4.0.0) + +### Added + +- Add floor function implementation and unit tests [#135](https://github.com/puppetlabs/puppetlabs-stdlib/pull/135) ([willaerk](https://github.com/willaerk)) +- (#19272) Add has_element() function [#130](https://github.com/puppetlabs/puppetlabs-stdlib/pull/130) ([jhoblitt](https://github.com/jhoblitt)) +- 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)) +- Fix typo in travis configuration [#122](https://github.com/puppetlabs/puppetlabs-stdlib/pull/122) ([jeffmccune](https://github.com/jeffmccune)) +- 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 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/2.6.0...3.2.0) + +## [2.6.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/2.6.0) - 2012-11-28 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/3.1.1...2.6.0) + +## [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) + +### 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)) + +## [2.5.1](https://github.com/puppetlabs/puppetlabs-stdlib/tree/2.5.1) - 2012-10-25 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/3.1.0...2.5.1) + +## [3.1.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/3.1.0) - 2012-10-25 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/2.5.0...3.1.0) + +## [2.5.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/2.5.0) - 2012-10-25 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/3.0.1...2.5.0) + +### Added + +- Add pe facts to stdlib [#99](https://github.com/puppetlabs/puppetlabs-stdlib/pull/99) ([haus](https://github.com/haus)) + +## [3.0.1](https://github.com/puppetlabs/puppetlabs-stdlib/tree/3.0.1) - 2012-10-11 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/3.0.0...3.0.1) + +### Fixed + +- (Maint) Fix mis-use of rvalue functions as statements [#91](https://github.com/puppetlabs/puppetlabs-stdlib/pull/91) ([jeffmccune](https://github.com/jeffmccune)) +- 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)) + +## [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) + +### Added + +- 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) + +### 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 + +- Fix up 2.3.x for new scope [#80](https://github.com/puppetlabs/puppetlabs-stdlib/pull/80) ([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)) + +## [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) + +### Fixed + +- fix regression in #11017 properly [#70](https://github.com/puppetlabs/puppetlabs-stdlib/pull/70) ([duritong](https://github.com/duritong)) + +## [2.3.2](https://github.com/puppetlabs/puppetlabs-stdlib/tree/2.3.2) - 2012-05-10 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/2.1.3...2.3.2) + +### Fixed + +- Make file_line default to ensure => present [#69](https://github.com/puppetlabs/puppetlabs-stdlib/pull/69) ([jeffmccune](https://github.com/jeffmccune)) + +## [2.1.3](https://github.com/puppetlabs/puppetlabs-stdlib/tree/2.1.3) - 2012-03-29 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/2.3.1...2.1.3) + +## [2.3.1](https://github.com/puppetlabs/puppetlabs-stdlib/tree/2.3.1) - 2012-03-13 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/2.3.0...2.3.1) + +### Fixed + +- (#13091) Fix LoadError exception with puppet apply [#50](https://github.com/puppetlabs/puppetlabs-stdlib/pull/50) ([jeffmccune](https://github.com/jeffmccune)) + +## [2.3.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/2.3.0) - 2012-03-12 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v2.2.1...2.3.0) + +### Added + +- (#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)) +- (#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)) +- 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) + +## [v2.1.2](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v2.1.2) - 2011-12-30 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v2.2.0...v2.1.2) + +### Added + +- (#10802) add new function get_module_path [#25](https://github.com/puppetlabs/puppetlabs-stdlib/pull/25) ([bodepd](https://github.com/bodepd)) + +## [v2.2.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v2.2.0) - 2011-11-08 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v2.1.1...v2.2.0) + +### Added + +- (#9859) Add root_home fact and tests [#17](https://github.com/puppetlabs/puppetlabs-stdlib/pull/17) ([jeffmccune](https://github.com/jeffmccune)) +- (#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) + +## [v2.1.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v2.1.0) - 2011-08-17 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v2.0.0...v2.1.0) + +### Added + +- (#9080) Add facts from /etc/puppetlabs/facts.d [#14](https://github.com/puppetlabs/puppetlabs-stdlib/pull/14) ([jeffmccune](https://github.com/jeffmccune)) + +## [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) + +## [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) + +## [v1.0.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v1.0.0) - 2011-08-04 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v0.1.7...v1.0.0) + +## [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) + +## [0.1.6](https://github.com/puppetlabs/puppetlabs-stdlib/tree/0.1.6) - 2011-06-15 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/0.1.5...0.1.6) + +## [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) + +## [0.1.4](https://github.com/puppetlabs/puppetlabs-stdlib/tree/0.1.4) - 2011-05-26 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/0.1.3...0.1.4) + +## [0.1.3](https://github.com/puppetlabs/puppetlabs-stdlib/tree/0.1.3) - 2011-05-25 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/0.1.2...0.1.3) + +## [0.1.2](https://github.com/puppetlabs/puppetlabs-stdlib/tree/0.1.2) - 2011-05-24 + +[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 + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/b305bbeac7a0560a271f34026f936b88b88da477...0.1.1) diff --git a/CODEOWNERS b/CODEOWNERS new file mode 100644 index 000000000..87a41832c --- /dev/null +++ b/CODEOWNERS @@ -0,0 +1,3 @@ +# Setting ownership to the modules team +# include Trusted Contributors +* @puppetlabs/modules @alexjfisher @b4ldr @bastelfreak @ekohl @smortex @seanmil diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5280da15e..e7a3a7c3f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,65 +1,3 @@ -# How to contribute +# Contributing to Puppet modules -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) -* [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 +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. diff --git a/Gemfile b/Gemfile index 75c7d853c..6dd3b77cc 100644 --- a/Gemfile +++ b/Gemfile @@ -1,44 +1,83 @@ -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 }] +source ENV['GEM_SOURCE'] || 'https://rubygems.org' + +def location_for(place_or_version, fake_version = nil) + git_url_regex = %r{\A(?(https?|git)[:@][^#]*)(#(?.*))?} + file_url_regex = %r{\Afile:\/\/(?.*)} + + 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 - [place, { :require => false }] + [place_or_version, { require: false }] end end group :development do - gem 'watchr' + 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 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 "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.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 "bigdecimal", '< 3.2.2', require: false, platforms: [:mswin, :mingw, :x64_mingw] end - -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 +group :development, :release_prep do + gem "puppet-strings", '~> 4.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", '~> 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 + +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) -facterversion = ENV['GEM_FACTER_VERSION'] -if facterversion - gem 'facter', *location_for(facterversion) +# 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 - gem 'facter', :require => false + gems['puppet'] = location_for(puppet_version) + gems['facter'] = location_for(facter_version) if facter_version end -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 +gems['hiera'] = location_for(hiera_version) if hiera_version + +gems.each do |gem_name, gem_params| + gem gem_name, *gem_params end -gem 'puppet-lint', '>= 0.3.2' +# Evaluate Gemfile.local and ~/.gemfile if they exist +extra_gemfiles = [ + "#{__FILE__}.local", + File.join(Dir.home, '.gemfile'), +] -# vim:ft=ruby +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/HISTORY.md b/HISTORY.md new file mode 100644 index 000000000..1889aef8f --- /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 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. + +## 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 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. + +## 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 (main) (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 server (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/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/Modulefile b/Modulefile deleted file mode 100644 index 9d2e8c220..000000000 --- a/Modulefile +++ /dev/null @@ -1,11 +0,0 @@ -name 'puppetlabs-stdlib' -version '4.1.0' -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' 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. diff --git a/README.markdown b/README.markdown deleted file mode 100644 index 822b8aff0..000000000 --- a/README.markdown +++ /dev/null @@ -1,1278 +0,0 @@ -# Puppet Labs Standard Library # - -[![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 - - * Stages - * Facts - * Functions - * Defined resource types - * 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. - - -- *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 - -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. - - -- *Type*: rvalue - -concat ------- -Appends the contents of array 2 onto array 1. - -*Example:* - - concat(['1','2','3'],['4','5','6']) - -Would result in: - - ['1','2','3','4','5','6'] - - -- *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 - -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, and false otherwise. - - 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. - -*Examples:* - - 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('abracadabra', 'bra') - Would return: 'acada' - - -- *Type*: rvalue - -delete_at ---------- -Deletes a determined indexed value from an array. - -*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. -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. - - -- *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 - -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') - } - - - -- *Type*: rvalue - -hash ----- -This function converts an array into a hash. - -*Examples:* - - hash(['a',1,'b',2,'c',3]) - -Would return: {'a'=>1,'b'=>2,'c'=>3} - - -- *Type*: rvalue - -intersection ------------ -This function returns an array an intersection of two. - -*Examples:* - - intersection(["a","b","c"],["b","c","d"]) - -Would return: ["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, 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 - -is_hash -------- -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 - -is_ip_address -------------- -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 - -is_numeric ----------- -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 - -join ----- -This function joins an array into a string using a separator. - -*Examples:* - - join(['a','b','c'], ",") - -Would result 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. - -*Examples:* - - join_keys_to_values({'a'=>1,'b'=>2}, " is ") - -Would result in: ["a is 1","b is 2"] - -- *Type*: rvalue - -keys ----- -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: - - $myhash = loadyaml('/etc/puppet/data/myhash.yaml') - - -- *Type*: rvalue - -lstrip ------- -Strips leading spaces to the left of a string. - -- *Type*: rvalue - -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. - -*Examples:* - - member(['a','b'], 'b') - -Would return: true - - member(['a','b'], 'c') - -Would return: false - -- *Type*: rvalue - -merge ------ -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'} - -When there is a duplicate key, the key in the rightmost hash will "win." - -- *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. - -- *Type*: rvalue - -parsejson ---------- -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 ----- -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. - -- *Type*: rvalue - -prefix ------- -This function applies a prefix to all elements in an array. - -*Examples:* - - prefix(['a','b','c'], 'p') - -Will return: ['pa','pb','pc'] - -- *Type*: rvalue - -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"] - -- *Type*: rvalue - -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'] - - -- *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 - -shuffle -------- -Randomizes the order of a string or array elements. - -- *Type*: rvalue - -size ----- -Returns the number of elements in a string or array. - -- *Type*: rvalue - -sort ----- -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 - -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 - 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 -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') - - - -- *Type*: statement - -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. - -The following values will pass: - - validate_slength("discombobulate",17) - validate_slength(["discombobulate","moo"],17) - -The following valueis will not: - - validate_slength("discombobulate",1) - validate_slength(["discombobulate","thermometer"],5) - - - -- *Type*: statement - -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' ]) - $undefined = undef - validate_string($undefined) - - -- *Type*: statement - -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] - - -- *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: - -* 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']. - - -- *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. - -*Example:* - - zip(['1','2','3'],['4','5','6']) - -Would result in: - - ["1", "4"], ["2", "5"], ["3", "6"] - - -- *Type*: rvalue - -*This page autogenerated on 2013-04-11 13:54:25 -0700* diff --git a/README.md b/README.md new file mode 100644 index 000000000..1c56e5e35 --- /dev/null +++ b/README.md @@ -0,0 +1,593 @@ +# stdlib + +#### Table of Contents + +1. [Overview](#overview) +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. [License](#license) +1. [Development](#development) +1. [Contributors](#contributors) + +## Overview + +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: + + * Stages + * Facts + * Functions + * 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 + +[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_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`. + +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): + + * setup + * main + * runtime + * setup_infra + * deploy_infra + * setup_app + * deploy_app + * deploy + +Sample usage: + +```puppet +node default { + include stdlib + class { java: stage => 'runtime' } +} +``` + +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 + +For information on the classes and types, see the [REFERENCE.md](https://github.com/puppetlabs/puppetlabs-stdlib/blob/main/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 consisting 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', '::'). + +#### `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. + +#### `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 + +#### `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 server 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. + +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). + +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 + +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 new file mode 100644 index 000000000..a472419bc --- /dev/null +++ b/REFERENCE.md @@ -0,0 +1,5910 @@ +# Reference + + + +## Table of Contents + +### Classes + +* [`stdlib`](#stdlib): This module manages stdlib. +* [`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 + +* [`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 + +* [`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): 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. +* [`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): 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 +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. +* [`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. +* [`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. +* [`enclose_ipv6`](#enclose_ipv6): Takes an array of ip addresses and encloses the ipv6 addresses with square brackets. +* [`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 +* [`fqdn_rand_string`](#fqdn_rand_string): DEPRECATED. Use the namespaced function [`stdlib::fqdn_rand_string`](#stdlibfqdn_rand_string) instead. +* [`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 +environment. +* [`getparam`](#getparam): Returns the value of a resource's parameter. +* [`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_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. +* [`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. +* [`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. +* [`member`](#member): This function determines if a variable is a member of an array. +* [`merge`](#merge): DEPRECATED. Use the namespaced function [`stdlib::merge`](#stdlibmerge) instead. +* [`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. +* [`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): **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): 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. +* [`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. +* [`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. +* [`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::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. +* [`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 +* [`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::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. +* [`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). +* [`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): 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. +* [`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. +* [`unix2dos`](#unix2dos): Returns the DOS version of the given string. +* [`uriescape`](#uriescape): Urlencodes a string or array of strings. +Requires either a single string or an array as an input. +* [`validate_augeas`](#validate_augeas): Perform validation of a string using an Augeas lens +* [`validate_cmd`](#validate_cmd): Perform validation of a string with an external command. +* [`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_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`](#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::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 +* [`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::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::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 +* [`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 + +### `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 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`. + +#### Examples + +##### + +```puppet +class { 'stdlib::manage': + 'create_resources' => { + 'file' => { + '/etc/motd.d/hello' => { + 'content' => 'I say Hi', + 'notify' => 'Service[sshd]', + }, + '/etc/motd' => { + 'ensure' => 'file', + 'epp' => { + 'template' => 'profile/motd.epp', + } + }, + '/etc/information' => { + 'ensure' => 'file', + 'erb' => { + 'template' => 'profile/informaiton.erb', + } + } + }, + 'package' => { + 'example' => { + 'ensure' => 'installed', + 'subscribe' => ['Service[sshd]', 'Exec[something]'], + } + } + } +} +``` + +##### + +```puppet +stdlib::manage::create_resources: + file: + '/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 + subscribe: + - 'Service[sshd]' + - 'Exec[something]' +``` + +#### Parameters + +The following parameters are available in the `stdlib::manage` class: + +* [`create_resources`](#-stdlib--manage--create_resources) + +##### `create_resources` + +Data type: `Hash[String, Hash]` + +A hash of resources to create +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: `{}` + +### `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` + +> 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 +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`](#-anchor--name) + +##### `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. + +* Ensure 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:* +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` + +Manage the state of this type. + +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. + +* [`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` + +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` + +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` + +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` + +##### `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` + +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` + +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` + +## Functions + +### `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` set the current class or definition as private. + +### `base64` + +Type: Ruby 3.x API + +> **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 + + $method = 'default' + $encodestring = base64('encode', 'thestring', $method) + $decodestring = base64('decode', 'dGhlc3RyaW5n', $method) + +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()` + +> **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 + +##### 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 + + $method = 'default' + $encodestring = base64('encode', 'thestring', $method) + $decodestring = base64('decode', 'dGhlc3RyaW5n', $method) + +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") +``` + +### `basename` + +Type: Ruby 3.x API + +Strips directory (and optional suffix) from a filename + +#### `basename()` + +The basename function. + +Returns: `String` The stripped filename + +### `batch_escape` + +Type: Ruby 4.x API + +DEPRECATED. Use the namespaced function [`stdlib::batch_escape`](#stdlibbatch_escape) instead. + +#### `batch_escape(Any *$args)` + +The batch_escape function. + +Returns: `Any` + +##### `*args` + +Data type: `Any` + + + +### `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 of usage** + + ``` + 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' + ``` + +#### `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 of usage** + + ``` + 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' + ``` + +Returns: `Any` The converted value to string of the given Boolean + +### `clamp` + +Type: Ruby 3.x API + +Strings are converted and compared numerically. Arrays of values are flattened +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 + +##### Example usage + +```puppet + +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. + +> *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 + +> *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]]` + +#### 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()` + +> *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 + +##### 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 + +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 S + +#### Examples + +##### Example usage + +```puppet + +``` + +#### `convert_base()` + +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 S + +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. + +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()` + +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 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 + +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()` + +The deep_merge function. + +Returns: `Hash` The merged + +##### 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." +``` + +### `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 + +> *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')` + +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. + +#### Examples + +##### Example usage + +```puppet + +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' + +['a', 'b', 'c', 'b'] - 'b' +Would return: ['a', 'c'] + +{'a'=>1,'b'=>2,'c'=>3} - ['b','c']) +Would return: {'a' => '1'} + +'abracadabra'.regsubst(/bra/, '', 'G') +Would return: 'acada' +``` + +#### `delete()` + +> *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')` + +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. + +##### Examples + +###### Example usage + +```puppet + +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' + +['a', 'b', 'c', 'b'] - 'b' +Would return: ['a', 'c'] + +{'a'=>1,'b'=>2,'c'=>3} - ['b','c']) +Would return: {'a' => '1'} + +'abracadabra'.regsubst(/bra/, '', 'G') +Would return: 'acada' +``` + +### `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 tar + +### `delete_regex` + +Type: Ruby 3.x API + +Multiple regular expressions are assumed to be matched as an OR. + +> *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 + +##### Example usage + +```puppet + +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} +``` + +#### `delete_regex()` + +Multiple regular expressions are assumed to be matched as an OR. + +> *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. + +##### Examples + +###### Example usage + +```puppet + +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} +``` + +### `delete_undef_values` + +Type: Ruby 3.x API + +> *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 } + +#### Examples + +##### Example usage + +```puppet + +$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] +``` + +#### `delete_undef_values()` + +> *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 } + +Returns: `Array` The given array now issing of undefined values. + +##### Examples + +###### Example usage + +```puppet + +$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] +``` + +### `delete_values` + +Type: Ruby 3.x API + +> *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' } + +#### Examples + +##### Example usage + +```puppet + +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 +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 + +##### 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 4.x API + +Function to print deprecation warnings, Logs a warning once for a given key. + +#### `deprecation(String $key, String $message, Optional[Boolean] $use_strict_setting)` + +The deprecation function. + +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). + +### `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. + +> *Note:* +Since Puppet 4 the minus (-) operator in the Puppet language does the same thing: +['a', 'b', 'c'] - ['b', 'c', 'd'] +Would return: `['a']` + +#### Examples + +##### Example usage + +```puppet + +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. + +> *Note:* +Since Puppet 4 the minus (-) operator in the Puppet language does the same thing: +['a', 'b', 'c'] - ['b', 'c', 'd'] +Would return: `['a']` + +Returns: `Array` The difference between the two given arrays + +##### Examples + +###### Example usage + +```puppet + +difference(["a","b","c"],["b","c","d"]) +Would return: `["a"]` +``` + +### `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 + +### `enclose_ipv6` + +Type: Ruby 3.x API + +Takes an array of ip addresses and encloses the ipv6 addresses with square brackets. + +#### `enclose_ipv6()` + +The enclose_ipv6 function. + +Returns: `Any` encloses the ipv6 addresses with square brackets. + +### `ensure_packages` + +Type: Ruby 4.x API + +DEPRECATED. Use the namespaced function [`stdlib::ensure_packages`](#stdlibensure_packages) instead. + +#### `ensure_packages(Any *$args)` + +The ensure_packages function. + +Returns: `Any` + +##### `*args` + +Data type: `Any` + + + +### `ensure_resource` + +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'}) +``` + +#### `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: + + 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 + +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()` + +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 + +##### Examples + +###### Example usage + +```puppet + +user { 'dan': + gid => 'mygroup', + ensure => present, +} +``` + +### `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 + +### `fqdn_rand_string` + +Type: Ruby 4.x API + +DEPRECATED. Use the namespaced function [`stdlib::fqdn_rand_string`](#stdlibfqdn_rand_string) instead. + +#### `fqdn_rand_string(Any *$args)` + +The fqdn_rand_string function. + +Returns: `Any` + +##### `*args` + +Data type: `Any` + + + +### `fqdn_rotate` + +Type: Ruby 4.x API + +DEPRECATED. Use the namespaced function [`stdlib::fqdn_rotate`](#stdlibfqdn_rotate) instead. + +#### `fqdn_rotate(Any *$args)` + +The fqdn_rotate function. + +Returns: `Any` + +##### `*args` + +Data type: `Any` + + + +### `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-dea6c79a +``` + +#### `fqdn_uuid()` + +The fqdn_uuid function. + +Returns: `Any` Returns a [RFC 4122](https://tools.ietf.org/html/rfc4122) valid version 5 UUID + +##### Examples + +###### Example Usage: + +```puppet +fqdn_uuid('puppetlabs.com') # Returns '9c70320f-6815-5fc5-ab0f-debe68bf764c' +fqdn_uuid('google.com') # Returns '64ee70a4-8cc1-5d25-abf2-dea6c79a +``` + +### `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` Returns the absolute path of the specified module for the current +environment. + +##### 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. + +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()` + +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']`` + +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': } +``` + +### `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` + +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` array of elements that match the provided regular expression. + +##### Examples + +###### Example Usage: + +```puppet +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_ip_address` + +Type: Ruby 4.x API + +DEPRECATED. Use the namespaced function [`stdlib::has_ip_address`](#stdlibhas_ip_address) instead. + +#### `has_ip_address(Any *$args)` + +The has_ip_address function. + +Returns: `Any` + +##### `*args` + +Data type: `Any` + + + +### `has_ip_network` + +Type: Ruby 4.x API + +DEPRECATED. Use the namespaced function [`stdlib::has_ip_network`](#stdlibhas_ip_network) instead. + +#### `has_ip_network(Any *$args)` + +The has_ip_network function. + +Returns: `Any` + +##### `*args` + +Data type: `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` 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) +``` + +### `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 + +### `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"] +``` + +### `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 +``` + +### `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. + +> *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. + +> **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. + +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 4.x API + +DEPRECATED. Use the namespaced function [`stdlib::merge`](#stdlibmerge) instead. + +#### `merge(Any *$args, Optional[Variant[Callable[2,2], Callable[3,3]]] &$block)` + +The merge function. + +Returns: `Any` + +##### `*args` + +Data type: `Any` + + + +##### `&block` + +Data type: `Optional[Variant[Callable[2,2], Callable[3,3]]]` + + + +### `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'} +``` + +### `num2bool` + +Type: Ruby 3.x API + +> *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. + +#### `num2bool()` + +> *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` Boolean(0) # false for any zero or negative number +Boolean(1) # true for any positive number + +### `os_version_gte` + +Type: Ruby 4.x API + +DEPRECATED. Use the namespaced function [`stdlib::os_version_gte`](#stdlibos_version_gte) instead. + +#### `os_version_gte(Any *$args)` + +The os_version_gte function. + +Returns: `Any` + +##### `*args` + +Data type: `Any` + + + +### `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` + + + +### `parsejson` + +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 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 the JSON string failed or if the JSON parse + evaluated to nil. + +Returns: `Any` convert JSON into Puppet structure + +### `parsepson` + +Type: Ruby 4.x API + +For more information on PSON please see the following link: +https://puppet.com/docs/puppet/7/http_api/pson.html + +#### Examples + +##### How to parse pson + +```puppet +$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 + +Returns: `Data` + +##### Examples + +###### How to parse pson + +```puppet +$data = parsepson('{"a":"1","b":"2"}') +``` + +##### `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` + +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:* + 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` converted YAML into Puppet structure + +### `pick` + +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: + +```$real_jenkins_version = pick($::jenkins_version, '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. + +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')``` + +> *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` the first value in a list of values that is not undefined or an empty string. + +### `pick_default` + +Type: Ruby 3.x API + +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') + +> *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. + + 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()` + +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') + +> *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. + + 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` 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. + +### `powershell_escape` + +Type: Ruby 4.x API + +DEPRECATED. Use the namespaced function [`stdlib::powershell_escape`](#stdlibpowershell_escape) instead. + +#### `powershell_escape(Any *$args)` + +The powershell_escape function. + +Returns: `Any` + +##### `*args` + +Data type: `Any` + + + +### `prefix` + +Type: Ruby 3.x API + +> *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 + +##### **Usage** + +```puppet + +prefix(['a','b','c'], 'p') +Will return: ['pa','pb','pc'] +``` + +#### `prefix()` + +> *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: `Hash` or [Array] The passed values now contains the passed prefix + +##### Examples + +###### **Usage** + +```puppet + +prefix(['a','b','c'], 'p') +Will return: ['pa','pb','pc'] +``` + +### `pry` + +Type: Ruby 3.x API + +This is useful for debugging manifest code at specific points during a compilation. + +#### Examples + +##### **Usage** + +```puppet + +`pry()` +``` + +#### `pry()` + +This is useful for debugging manifest code at specific points during a compilation. + +Returns: `Any` debugging information + +##### Examples + +###### **Usage** + +```puppet + +`pry()` +``` + +### `pw_hash` + +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 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. 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| + +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. + +Returns: `String` Provides a crypt hash usable on most POSIX systems. + +### `range` + +Type: Ruby 3.x API + +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 + +#### Examples + +##### **Usage** + +```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] +``` + +#### `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** + +```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] +``` + +### `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()` + +The regexpescape function. + +Returns: `String` A string of characters with metacharacters converted to their escaped form. + +### `reject` + +Type: Ruby 3.x API + +> *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 + +##### **Usage** + +```puppet + +reject(['aaa','bbb','ccc','aaaddd'], 'aaa') + +Would return: ['bbb','ccc'] +``` + +#### `reject()` + +> *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: `Any` an array containing all the elements which doesn'' match the provided regular expression + +##### Examples + +###### **Usage** + +```puppet + +reject(['aaa','bbb','ccc','aaaddd'], 'aaa') + +Would return: ['bbb','ccc'] +``` + +### `reverse` + +Type: Ruby 3.x API + +> *Note:* that the same can be done with the reverse_each() function in Puppet. + +#### `reverse()` + +> *Note:* that the same can be done with the reverse_each() function in Puppet. + +Returns: `Any` reversed string or array + +### `seeded_rand` + +Type: Ruby 4.x API + +DEPRECATED. Use the namespaced function [`stdlib::seeded_rand`](#stdlibseeded_rand) instead. + +#### `seeded_rand(Any *$args)` + +The seeded_rand function. + +Returns: `Any` + +##### `*args` + +Data type: `Any` + + + +### `seeded_rand_string` + +Type: Ruby 4.x API + +DEPRECATED. Use the namespaced function [`stdlib::seeded_rand_string`](#stdlibseeded_rand_string) instead. + +#### `seeded_rand_string(Any *$args)` + +The seeded_rand_string function. + +Returns: `Any` + +##### `*args` + +Data type: `Any` + + + +### `shell_escape` + +Type: Ruby 4.x API + +DEPRECATED. Use the namespaced function [`stdlib::shell_escape`](#stdlibshell_escape) instead. + +#### `shell_escape(Any *$args)` + +The shell_escape function. + +Returns: `Any` + +##### `*args` + +Data type: `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` 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 + +### `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::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. + +#### `stdlib::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 + +### `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, Sensitive[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::ensure_packages` + +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. + +#### `stdlib::ensure_packages(Variant[String[1], Array[String[1]]] $packages, Optional[Hash] $default_attributes)` + +The stdlib::ensure_packages function. + +Returns: `Undef` Returns nothing. + +##### `packages` + +Data type: `Variant[String[1], Array[String[1]]]` + +The packages to ensure are installed. + +##### `default_attributes` + +Data type: `Optional[Hash]` + +Default attributes to be passed to the `ensure_resource()` function + +#### `stdlib::ensure_packages(Hash[String[1], Any] $packages, Optional[Hash] $default_attributes)` + +The stdlib::ensure_packages function. + +Returns: `Undef` Returns nothing. + +##### `packages` + +Data type: `Hash[String[1], Any]` + +The packages to ensure are installed. The keys are packages and values are the attributes specific to that package. + +##### `default_attributes` + +Data type: `Optional[Hash]` + +Default attributes. Package specific attributes from the `packages` parameter will take precedence. + +### `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::fqdn_rand_string` + +Type: Ruby 4.x API + +Optionally, you can specify a character set for the function (defaults to alphanumeric). + +#### Examples + +##### Example Usage: + +```puppet +stdlib::fqdn_rand_string(10) +stdlib::fqdn_rand_string(10, 'ABCDEF!@$%^') +stdlib::fqdn_rand_string(10, undef, 'custom 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). + +Returns: `String` + +##### Examples + +###### Example Usage: + +```puppet +stdlib::fqdn_rand_string(10) +stdlib::fqdn_rand_string(10, 'ABCDEF!@$%^') +stdlib::fqdn_rand_string(10, undef, 'custom seed') +``` + +##### `length` + +Data type: `Integer[1]` + +The length of the resulting string. + +##### `charset` + +Data type: `Optional[Optional[String]]` + +The character set to use. + +##### `*seed` + +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 + +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::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 + +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::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 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. + +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 + +##### Using stdlib::merge() + +```puppet +$hash1 = {'one' => 1, 'two', => 2} +$hash2 = {'two' => 'dos', 'three', => 'tres'} +$merged_hash = stdlib::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'].stdlib::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'].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 } +``` + +#### `stdlib::merge(Variant[Hash[Scalar,Any], Undef, String[0,0]] *$args)` + +The stdlib::merge function. + +Returns: `Hash[Scalar,Any]` The merged hash + +##### `*args` + +Data type: `Variant[Hash[Scalar,Any], Undef, String[0,0]]` + +Repeated Param - The hashes that are to be merged + +#### `stdlib::merge(Iterable *$args, Callable[3,3] &$block)` + +The stdlib::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` + +#### `stdlib::merge(Iterable *$args, Callable[2,2] &$block)` + +The stdlib::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` + +### `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 + +> *Note:* +Only the major version is taken into account. + +#### Examples + +##### Example usage:# + +```puppet +if stdlib::os_version_gte('Debian', '9') { } +if stdlib::os_version_gte('Ubuntu', '18.04') { } +``` + +#### `stdlib::os_version_gte(String[1] $os, String[1] $version)` + +> *Note:* +Only the major version is taken into account. + +Returns: `Boolean` `true` or `false + +##### Examples + +###### Example usage:# + +```puppet +if stdlib::os_version_gte('Debian', '9') { } +if stdlib::os_version_gte('Ubuntu', '18.04') { } +``` + +##### `os` + +Data type: `String[1]` + +operating system + +##### `version` + +Data type: `String[1]` + + + +### `stdlib::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 = stdlib::parsehocon("{any valid hocon: string}") +``` + +#### `stdlib::parsehocon(String $hocon_string, Optional[Any] $default)` + +The stdlib::parsehocon function. + +Returns: `Data` + +##### Examples + +###### How to parse hocon + +```puppet +$data = stdlib::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 + +### `stdlib::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. + +#### `stdlib::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 + +### `stdlib::seeded_rand` + +Type: Ruby 4.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. + +#### `stdlib::seeded_rand(Integer[1] $max, String $seed)` + +The stdlib::seeded_rand function. + +Returns: `Integer` A random number greater than or equal to 0 and less than max + +##### `max` + +Data type: `Integer[1]` + +The maximum value. + +##### `seed` + +Data type: `String` + +The seed used for repeatable randomness. + +### `stdlib::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 +stdlib::seeded_rand_string(8, "${module_name}::redis_password") +``` + +##### Generate a random string from a specific set of characters: + +```puppet +stdlib::seeded_rand_string(5, '', 'abcdef') +``` + +#### `stdlib::seeded_rand_string(Integer[1] $length, String $seed, Optional[String[2]] $charset)` + +The stdlib::seeded_rand_string function. + +Returns: `String` Random string. + +##### Examples + +###### Generate a consistently random string of length 8 with a seed: + +```puppet +stdlib::seeded_rand_string(8, "${module_name}::redis_password") +``` + +###### Generate a random string from a specific set of characters: + +```puppet +stdlib::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. + +### `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::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. + +#### `stdlib::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` An escaped string that can be safely used in a Bourne shell command line. + +##### `string` + +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 + +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::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 + +Convert a data structure and output to JSON + +#### Examples + +##### Output JSON to a file + +```puppet +file { '/tmp/my.json': + ensure => file, + content => stdlib::to_json($myhash), +} +``` + +#### `stdlib::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 => stdlib::to_json($myhash), +} +``` + +##### `data` + +Data type: `Any` + +Data structure which needs to be converted into JSON + +### `stdlib::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 => 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 => ' '}), + } +``` + +#### `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)` + +The stdlib::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 => 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 => ' '}), + } +``` + +##### `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. + +### `stdlib::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 = <%= stdlib::to_python($listen) %> + PORT = <%= stdlib::to_python($mailserver) %> + | SETTINGS +} +``` + +#### `stdlib::to_python(Any $object)` + +The stdlib::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 = <%= stdlib::to_python($listen) %> + PORT = <%= stdlib::to_python($mailserver) %> + | SETTINGS +} +``` + +##### `object` + +Data type: `Any` + +The object to be converted + +### `stdlib::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 = <%= stdlib::to_ruby($listen) %> + PORT = <%= stdlib::to_ruby($mailserver) %> + | SETTINGS +} +``` + +#### `stdlib::to_ruby(Any $object)` + +The stdlib::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 = <%= stdlib::to_ruby($listen) %> + PORT = <%= stdlib::to_ruby($mailserver) %> + | SETTINGS +} +``` + +##### `object` + +Data type: `Any` + +The object to be converted + +### `stdlib::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 => stdlib::to_toml($myhash), +} +``` + +#### `stdlib::to_toml(Hash $data)` + +The stdlib::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 => stdlib::to_toml($myhash), +} +``` + +##### `data` + +Data type: `Hash` + +Data structure which needs to be converted into TOML + +### `stdlib::to_yaml` + +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 => stdlib::to_yaml($myhash), +} +``` + +##### Use options to control the output format + +```puppet +file { '/tmp/my.yaml': + ensure => file, + content => stdlib::to_yaml($myhash, {indentation => 4}) +} +``` + +#### `stdlib::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 => stdlib::to_yaml($myhash), +} +``` + +###### Use options to control the output format + +```puppet +file { '/tmp/my.yaml': + ensure => file, + content => stdlib::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`. + +### `stdlib::type_of` + +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. + +#### Examples + +##### how to compare values' types + +```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") } +``` + +##### 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") } +``` + +#### `stdlib::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. + +The built-in type() function in puppet is generally preferred over this function +this function is provided for backwards compatibility. + +Returns: `String` the type of the passed value + +##### Examples + +###### how to compare values' types + +```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") } +``` + +###### 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") } +``` + +##### `value` + +Data type: `Any` + + + +### `stdlib::validate_domain_name` + +Type: Ruby 4.x API + +Validate that all values passed are syntactically correct domain names. +Fail compilation if any value fails this check. + +#### Examples + +##### 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') +``` + +##### Failing examples (causing compilation to abort) + +```puppet +stdlib::validate_domain_name(1) +stdlib::validate_domain_name(true) +stdlib::validate_domain_name('invalid domain') +stdlib::validate_domain_name('-foo.example.com') +``` + +#### `stdlib::validate_domain_name(Variant[Stdlib::Fqdn, Stdlib::Dns::Zone] *$values)` + +The stdlib::validate_domain_name function. + +Returns: `Undef` passes when the given values are syntactically correct domain names or raise an error when they are not and fails compilation + +##### Examples + +###### 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') +``` + +###### Failing examples (causing compilation to abort) + +```puppet +stdlib::validate_domain_name(1) +stdlib::validate_domain_name(true) +stdlib::validate_domain_name('invalid domain') +stdlib::validate_domain_name('-foo.example.com') +``` + +##### `*values` + +Data type: `Variant[Stdlib::Fqdn, Stdlib::Dns::Zone]` + +A domain name or an array of domain names to check + +### `stdlib::validate_email_address` + +Type: Ruby 4.x API + +Validate that all values passed are valid email addresses. +Fail compilation if any value fails this check. + +#### Examples + +##### 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) +``` + +##### Failing examples (causing compilation to abort) + +```puppet +$some_array = [ 'bad_email@/d/efdf.com' ] +stdlib::validate_email_address($some_array) +``` + +#### `stdlib::validate_email_address(Stdlib::Email *$values)` + +The stdlib::validate_email_address function. + +Returns: `Undef` Fail compilation if any value fails this check. + +##### Examples + +###### 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) +``` + +###### Failing examples (causing compilation to abort) + +```puppet +$some_array = [ 'bad_email@/d/efdf.com' ] +stdlib::validate_email_address($some_array) +``` + +##### `*values` + +Data type: `Stdlib::Email` + +An e-mail address or an array of e-mail addresses 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 + +> *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 + +### `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 4.x API + +DEPRECATED. Use the native Puppet fuctionality instead of this function. eg `Integer(Timestamp().strftime('%s'))` + +#### `time(Any *$args)` + +The time function. + +Returns: `Any` + +##### `*args` + +Data type: `Any` + + + +### `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 + +DEPRECATED. Use the namespaced function [`stdlib::to_json`](#stdlibto_json) instead. + +#### `to_json(Any *$args)` + +The to_json function. + +Returns: `Any` + +##### `*args` + +Data type: `Any` + + + +### `to_json_pretty` + +Type: Ruby 4.x API + +DEPRECATED. Use the namespaced function [`stdlib::to_json_pretty`](#stdlibto_json_pretty) instead. + +#### `to_json_pretty(Any *$args)` + +The to_json_pretty function. + +Returns: `Any` + +##### `*args` + +Data type: `Any` + + + +### `to_python` + +Type: Ruby 4.x API + +DEPRECATED. Use the namespaced function [`stdlib::to_python`](#stdlibto_python) instead. + +#### `to_python(Any *$args)` + +The to_python function. + +Returns: `Any` + +##### `*args` + +Data type: `Any` + + + +### `to_ruby` + +Type: Ruby 4.x API + +DEPRECATED. Use the namespaced function [`stdlib::to_ruby`](#stdlibto_ruby) instead. + +#### `to_ruby(Any *$args)` + +The to_ruby function. + +Returns: `Any` + +##### `*args` + +Data type: `Any` + + + +### `to_toml` + +Type: Ruby 4.x API + +DEPRECATED. Use the namespaced function [`stdlib::to_toml`](#stdlibto_toml) instead. + +#### `to_toml(Any *$args)` + +The to_toml function. + +Returns: `Any` + +##### `*args` + +Data type: `Any` + + + +### `to_yaml` + +Type: Ruby 4.x API + +DEPRECATED. Use the namespaced function [`stdlib::to_yaml`](#stdlibto_yaml) instead. + +#### `to_yaml(Any *$args)` + +The to_yaml function. + +Returns: `Any` + +##### `*args` + +Data type: `Any` + + + +### `type_of` + +Type: Ruby 4.x API + +DEPRECATED. Use the namespaced function [`stdlib::type_of`](#stdlibtype_of) instead. + +#### `type_of(Any *$args)` + +The type_of function. + +Returns: `Any` + +##### `*args` + +Data type: `Any` + + + +### `union` + +Type: Ruby 3.x API + +This function returns a union of two or more arrays. + +#### Examples + +##### **Usage** + +```puppet + +union(["a","b","c"],["b","c","d"]) +Would return: ["a","b","c","d"] +``` + +#### `union()` + +The union function. + +Returns: `Any` a unionized array of two or more arrays + +##### Examples + +###### **Usage** + +```puppet + +union(["a","b","c"],["b","c","d"]) +Would return: ["a","b","c","d"] +``` + +### `unix2dos` + +Type: Ruby 3.x API + +Takes a single string argument. + +#### `unix2dos()` + +Takes a single string argument. + +Returns: `Any` the DOS version of the given string. + +### `uriescape` + +Type: Ruby 3.x API + +> **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. + +#### `uriescape()` + +> **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. + +Returns: `String` a string that contains the converted value + +### `validate_augeas` + +Type: Ruby 3.x API + +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. + +#### 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']) + +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()` + +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. + +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']) + +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_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 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: + +#### Examples + +##### **Usage** + +```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()` + +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: + +Returns: `Any` validate of a string with an external command + +##### Examples + +###### **Usage** + +```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` + +Type: Ruby 4.x API + +DEPRECATED. Use the namespaced function [`stdlib::validate_domain_name`](#stdlibvalidate_domain_name) instead. + +#### `validate_domain_name(Any *$args)` + +The validate_domain_name function. + +Returns: `Any` + +##### `*args` + +Data type: `Any` + + + +### `validate_email_address` + +Type: Ruby 4.x API + +DEPRECATED. Use the namespaced function [`stdlib::validate_email_address`](#stdlibvalidate_email_address) instead. + +#### `validate_email_address(Any *$args)` + +The validate_email_address function. + +Returns: `Any` + +##### `*args` + +Data type: `Any` + + + +### `validate_legacy` + +Type: Ruby 4.x API + +**Deprecated:** Validate a value against both the target_type (new). + +#### `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). + +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` + +Data type: `Type` + + + +##### `function_name` + +Data type: `String` + +Unused + +##### `value` + +Data type: `Any` + + + +##### `*args` + +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` Legacy validation method + +##### `scope` + +Data type: `Any` + +The main value that will be passed to the method + +##### `type_string` + +Data type: `String` + + + +##### `function_name` + +Data type: `String` + +Unused + +##### `value` + +Data type: `Any` + + + +##### `*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 + +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. + +### `values_at` + +Type: Ruby 3.x API + +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 + +> *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']` + +#### Examples + +##### **Usage** + +```puppet + +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'] +``` + +#### `values_at()` + +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 + +> *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']` + +Returns: `Any` an array of values identified by location + +##### Examples + +###### **Usage** + +```puppet + +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'] +``` + +### `zip` + +Type: Ruby 3.x API + +Takes one element from first array and merges corresponding elements from second array. + +#### Examples + +##### + +```puppet +zip(['1','2','3'],['4','5','6']) +Would result in: ["1", "4"], ["2", "5"], ["3", "6"] +``` + +#### `zip()` + +The zip function. + +Returns: `Any` This generates a sequence of n-element arrays, where n is one more than the count of arguments. + +##### Examples + +###### + +```puppet +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[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/]` + +### `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 `Hash[String[1], Hash[String[1], Any]]` + +### `Stdlib::Datasize` + +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 +lint:ignore:140chars + +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/]` + +### `Stdlib::Ensure::File` + +Validate the value of the ensure parameter for a file + +Alias of `Enum['present', 'file', 'directory', 'link', 'absent']` + +### `Stdlib::Ensure::File::Directory` + +Validate the ensure parameter of a "directory" file resource + +Alias of `Enum['directory', 'absent']` + +### `Stdlib::Ensure::File::File` + +Validate the ensure parameter of a "file" file resource + +Alias of `Enum['file', 'absent']` + +### `Stdlib::Ensure::File::Link` + +Validate the ensure parameter of a "link" file resource + +Alias of `Enum['link', 'absent']` + +### `Stdlib::Ensure::Package` + +Validate the value of the ensure parameter for a package + +Alias of `Variant[Enum['present', 'absent', 'purged', 'disabled', 'installed', 'latest'], String[1]]` + +### `Stdlib::Ensure::Service` + +Validate the value of the ensure parameter of a service resource + +Alias of `Enum['stopped', 'running']` + +### `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` + +Validate the source parameter on file types + +Alias of + +```puppet +Variant[Stdlib::Absolutepath, Stdlib::HTTPUrl, Pattern[ + /\Afile:\/\/\/([^\n\/\0]+(\/)?)+\z/, + /\Apuppet:\/\/(([\w-]+\.?)+)?\/([^\n\/\0]+(\/)?)+\z/, + ]] +``` + +### `Stdlib::Fqdn` + +Validate a Fully Qualified Domain Name + +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` + +Validate a HTTPS URL + +Alias of `Pattern[/(?i:\Ahttps:\/\/.*\z)/]` + +### `Stdlib::HTTPUrl` + +Validate a HTTP(S) URL + +Alias of `Pattern[/(?i:\Ahttps?:\/\/.*\z)/]` + +### `Stdlib::Host` + +Validate a host (FQDN or IP address) + +Alias of `Variant[Stdlib::Fqdn, Stdlib::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 + +* **DEPRECATED** Use Stdlib::Http::Status + +* **See also** + * Stdlib::Http::Status + +Alias of `Stdlib::Http::Status` + +### `Stdlib::IP::Address` + +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 + +Alias of `Variant[Stdlib::IP::Address::V4::Nosubnet, Stdlib::IP::Address::V6::Nosubnet]` + +### `Stdlib::IP::Address::V4` + +Validate an IPv4 address + +Alias of `Variant[Stdlib::IP::Address::V4::CIDR, Stdlib::IP::Address::V4::Nosubnet]` + +### `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/]` + +### `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/]` + +### `Stdlib::IP::Address::V6` + +Validate an IPv6 address + +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` + +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` + +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` + +Validate a compressed IPv6 address + +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` + +Validate a full IPv6 address + +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` + +Validate an IPv6 address without subnet + +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` + +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` + +Validate compressed IPv6 address without subnet + +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` + +Validate full IPv6 address without subnet + +Alias of `Pattern[/\A[[:xdigit:]]{1,4}(:[[:xdigit:]]{1,4}){7}\z/]` + +### `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` + +Validate an ObjectStore + +Alias of `Variant[Stdlib::ObjectStore::GSUri, Stdlib::ObjectStore::S3Uri]` + +### `Stdlib::ObjectStore::GSUri` + +Validate a Google Cloud object store URI + +Alias of `Pattern[/\Ags:\/\/.*\z/]` + +### `Stdlib::ObjectStore::S3Uri` + +Validate an Amazon Web Services S3 object store URI + +Alias of `Pattern[/\As3:\/\/.*\z/]` + +### `Stdlib::Port` + +Validate a port number + +Alias of `Integer[0, 65535]` + +### `Stdlib::Port::Dynamic` + +Validate a dynamic port number + +Alias of `Integer[49152, 65535]` + +### `Stdlib::Port::Ephemeral` + +Validate an ephemeral port number + +Alias of `Stdlib::Port::Dynamic` + +### `Stdlib::Port::Privileged` + +Validate a priviliged port number + +Alias of `Integer[1, 1023]` + +### `Stdlib::Port::Registered` + +Validate a registered port number + +Alias of `Stdlib::Port::User` + +### `Stdlib::Port::Unprivileged` + +Validate an unprivileged port number + +Alias of `Integer[1024, 65535]` + +### `Stdlib::Port::User` + +Validate a port number usable by a user + +Alias of `Integer[1024, 49151]` + +### `Stdlib::Syslogfacility` + +Validate a syslog facility + +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[/\A\/([^\n\/\0]+\/*)*\z/]` + +### `Stdlib::Windowspath` + +Validate a Windows path + +Alias of `Pattern[/\A(([a-zA-Z]:[\\\/])|([\\\/][\\\/][^\\\/]+[\\\/][^\\\/]+)|([\\\/][\\\/]\?[\\\/][^\\\/]+)).*\z/]` + +### `Stdlib::Yes_no` + +Validate a yes / no value + +Alias of `Pattern[/\A(?i:(yes|no))\z/]` + 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/Rakefile b/Rakefile index 4ed1327a3..31b593053 100644 --- a/Rakefile +++ b/Rakefile @@ -1,18 +1,18 @@ -require 'rubygems' +# frozen_string_literal: true + +require 'bundler' +require 'puppet_litmus/rake_tasks' if Gem.loaded_specs.key? 'puppet_litmus' require 'puppetlabs_spec_helper/rake_tasks' -require 'puppet-lint/tasks/puppet-lint' +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.ignore_paths = ["spec/**/*.pp", "pkg/**/*.pp"] +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"] -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 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/tests/file_line.pp b/examples/file_line.pp similarity index 74% rename from tests/file_line.pp rename to examples/file_line.pp index eea693e15..e628bea34 100644 --- a/tests/file_line.pp +++ b/examples/file_line.pp @@ -1,9 +1,9 @@ # This is a simple smoke test # of the file_line resource type. file { '/tmp/dansfile': - ensure => present -}-> -file_line { 'dans_line': + ensure => file, +} +-> file_line { 'dans_line': line => 'dan is awesome', path => '/tmp/dansfile', } diff --git a/tests/has_interface_with.pp b/examples/has_interface_with.pp similarity index 99% rename from tests/has_interface_with.pp rename to examples/has_interface_with.pp index e1f1353cd..8906a66c5 100644 --- a/tests/has_interface_with.pp +++ b/examples/has_interface_with.pp @@ -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/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 99% rename from tests/has_ip_network.pp rename to examples/has_ip_network.pp index a15d8c011..669a29127 100644 --- a/tests/has_ip_network.pp +++ b/examples/has_ip_network.pp @@ -1,4 +1,3 @@ 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/tests/init.pp b/examples/init.pp similarity index 100% rename from tests/init.pp rename to examples/init.pp diff --git a/functions/deferrable_epp.pp b/functions/deferrable_epp.pp new file mode 100644 index 000000000..ae3d653d9 --- /dev/null +++ b/functions/deferrable_epp.pp @@ -0,0 +1,18 @@ +# 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, Sensitive[String], Deferred] { + if $variables.stdlib::nested_values.any |$value| { $value.is_a(Deferred) } { + Deferred( + 'inline_epp', + [find_template($template).file, $variables], + ) + } + else { + epp($template, $variables) + } +} diff --git a/functions/ensure.pp b/functions/ensure.pp new file mode 100644 index 000000000..9b63d44e5 --- /dev/null +++ b/functions/ensure.pp @@ -0,0 +1,33 @@ +# @summary function to cast ensure parameter to resource specific value +# +# @return [String] +function stdlib::ensure( + Variant[Boolean, Enum['present', 'absent']] $ensure, + Optional[Enum['directory', 'link', 'mounted', 'service', 'file', 'package']] $resource = undef, +) >> String { + $_ensure = $ensure ? { + Boolean => $ensure.bool2str('present', 'absent'), + default => $ensure, + } + case $resource { + 'package': { + $_ensure ? { + 'present' => 'installed', + default => 'absent', + } + } + 'service': { + $_ensure ? { + 'present' => 'running', + default => 'stopped', + } + } + undef: { $_ensure } + default: { + $_ensure ? { + 'present' => $resource, + default => $_ensure, + } + } + } +} 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/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/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/lib/facter/facter_dot_d.rb b/lib/facter/facter_dot_d.rb deleted file mode 100644 index e414b2077..000000000 --- a/lib/facter/facter_dot_d.rb +++ /dev/null @@ -1,202 +0,0 @@ -# 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 /tmp/facts_cache.yaml 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="/tmp/facts_cache.yml") - @dir = dir - @cache_file = cache_file - @cache = nil - @types = {".txt" => :txt, ".json" => :json, ".yaml" => :yaml} - end - - def entries - Dir.entries(@dir).reject{|f| f =~ /^\.|\.ttl$/}.sort.map {|f| File.join(@dir, f) } - rescue - [] - end - - def fact_type(file) - extension = File.extname(file) - - type = @types[extension] || :unknown - - type = :script if type == :unknown && File.executable?(file) - - return type - end - - def txt_parser(file) - File.readlines(file).each do |line| - if line =~ /^(.+)=(.+)$/ - var = $1; val = $2 - - Facter.add(var) do - setcode { val } - end - end - end - rescue Exception => e - Facter.warn("Failed to handle #{file} as text facts: #{e.class}: #{e}") - end - - def json_parser(file) - begin - require 'json' - rescue LoadError - retry if require 'rubygems' - raise - end - - JSON.load(File.read(file)).each_pair do |f, v| - Facter.add(f) do - setcode { v } - end - end - rescue Exception => e - Facter.warn("Failed to handle #{file} as json facts: #{e.class}: #{e}") - end - - def yaml_parser(file) - require 'yaml' - - YAML.load_file(file).each_pair do |f, v| - Facter.add(f) do - setcode { v } - end - end - rescue Exception => e - Facter.warn("Failed to handle #{file} as yaml facts: #{e.class}: #{e}") - end - - def script_parser(file) - result = cache_lookup(file) - ttl = cache_time(file) - - unless result - result = Facter::Util::Resolution.exec(file) - - if ttl > 0 - Facter.debug("Updating cache for #{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 - - Facter.add(var) do - setcode { val } - end - end - end - rescue Exception => e - Facter.warn("Failed to handle #{file} as script facts: #{e.class}: #{e}") - Facter.debug(e.backtrace.join("\n\t")) - end - - def cache_save! - cache = load_cache - File.open(@cache_file, "w", 0600) {|f| f.write(YAML.dump(cache)) } - rescue - end - - def cache_store(file, data) - load_cache - - @cache[file] = {:data => data, :stored => Time.now.to_i} - rescue - end - - def cache_lookup(file) - cache = load_cache - - return nil if cache.empty? - - ttl = cache_time(file) - - if 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 - rescue - return nil - end - - def cache_time(file) - meta = file + ".ttl" - - return File.read(meta).chomp.to_i - rescue - return 0 - end - - def load_cache - unless @cache - if File.exist?(@cache_file) - @cache = YAML.load_file(@cache_file) - else - @cache = {} - end - end - - return @cache - rescue - @cache = {} - return @cache - end - - def create - entries.each do |fact| - type = fact_type(fact) - parser = "#{type}_parser" - - if respond_to?("#{type}_parser") - Facter.debug("Parsing #{fact} using #{parser}") - - send(parser, fact) - end - end - end -end - - -mdata = Facter.version.match(/(\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 and 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 - windows_facts_dot_d = File.join(Dir::COMMON_APPDATA, 'PuppetLabs', 'facter', 'facts.d') - Facter::Util::DotD.new(windows_facts_dot_d).create - end - end - end -end diff --git a/lib/facter/package_provider.rb b/lib/facter/package_provider.rb new file mode 100644 index 000000000..c5c1ef859 --- /dev/null +++ b/lib/facter/package_provider.rb @@ -0,0 +1,21 @@ +# frozen_string_literal: true + +# 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' + +# 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 + Puppet::Type.type(:package).newpackage(name: 'dummy', allow_virtual: 'true')[:provider].to_s + end +end diff --git a/lib/facter/pe_version.rb b/lib/facter/pe_version.rb index 0cc0f64e9..716ff7198 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 @@ -8,46 +10,53 @@ # # Caveats: # -Facter.add("pe_version") do +# Fact: pe_version +Facter.add('pe_version') do setcode do - pe_ver = Facter.value("puppetversion").match(/Puppet Enterprise (\d+\.\d+\.\d+)/) - pe_ver[1] if pe_ver + 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 -Facter.add("is_pe") do +# Fact: is_pe +Facter.add('is_pe') do setcode do - if Facter.value(:pe_version).to_s.empty? then - false - else - true - end + !Facter.value(:pe_version).to_s.empty? end end -Facter.add("pe_major_version") do - confine :is_pe => true +# Fact: pe_major_version +Facter.add('pe_major_version') do + confine is_pe: true setcode do - if pe_version = Facter.value(:pe_version) - pe_version.to_s.split('.')[0] - end + pe_version = Facter.value(:pe_version) + pe_version.to_s.split('.')[0] if pe_version end end -Facter.add("pe_minor_version") do - confine :is_pe => true +# Fact: pe_minor_version +Facter.add('pe_minor_version') do + confine is_pe: true setcode do - if pe_version = Facter.value(:pe_version) - pe_version.to_s.split('.')[1] - end + pe_version = Facter.value(:pe_version) + pe_version.to_s.split('.')[1] if pe_version end end -Facter.add("pe_patch_version") do - confine :is_pe => true +# Fact: pe_patch_version +Facter.add('pe_patch_version') do + confine is_pe: true setcode do - if pe_version = Facter.value(:pe_version) - pe_version.to_s.split('.')[2] - end + pe_version = Facter.value(:pe_version) + pe_version.to_s.split('.')[2] if pe_version end end diff --git a/lib/facter/puppet_settings.rb b/lib/facter/puppet_settings.rb new file mode 100644 index 000000000..951b2eb7c --- /dev/null +++ b/lib/facter/puppet_settings.rb @@ -0,0 +1,46 @@ +# 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 +# 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. +# +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.exist?(rb_file) || raise(e) +end + +# Facter fact returns the value of the Puppet vardir +Facter.add(:puppet_vardir) do + setcode do + Facter::Util::PuppetSettings.with_puppet do + Puppet[:vardir] + end + 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 + Puppet[:environmentpath] + end + end +end + +# Facter fact returns the value of the Puppet server +Facter.add(:puppet_server) do + setcode do + Facter::Util::PuppetSettings.with_puppet do + Puppet[:server] + 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 diff --git a/lib/facter/root_home.rb b/lib/facter/root_home.rb index 8249f7d02..c44d64a7b 100644 --- a/lib/facter/root_home.rb +++ b/lib/facter/root_home.rb @@ -1,19 +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. - -module Facter::Util::RootHome - class << self - def get_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 +# frozen_string_literal: true Facter.add(:root_home) do - setcode { Facter::Util::RootHome.get_root_home } + setcode do + require 'etc' + rescue LoadError + # Unavailable on platforms like Windows + else + Etc.getpwnam('root')&.dir + end end diff --git a/lib/facter/service_provider.rb b/lib/facter/service_provider.rb new file mode 100644 index 000000000..3d4e44a57 --- /dev/null +++ b/lib/facter/service_provider.rb @@ -0,0 +1,19 @@ +# frozen_string_literal: true + +# 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: +# +require 'puppet/type' +require 'puppet/type/service' + +Facter.add(:service_provider) do + setcode do + 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..d808f264c 100644 --- a/lib/facter/util/puppet_settings.rb +++ b/lib/facter/util/puppet_settings.rb @@ -1,21 +1,18 @@ -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 +# 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 + # 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/batch_escape.rb b/lib/puppet/functions/batch_escape.rb new file mode 100644 index 000000000..07d326a88 --- /dev/null +++ b/lib/puppet/functions/batch_escape.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::batch_escape`](#stdlibbatch_escape) instead. +Puppet::Functions.create_function(:batch_escape) do + dispatch :deprecation_gen do + repeated_param 'Any', :args + end + def deprecation_gen(*args) + 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/deprecation.rb b/lib/puppet/functions/deprecation.rb new file mode 100644 index 000000000..f508cf029 --- /dev/null +++ b/lib/puppet/functions/deprecation.rb @@ -0,0 +1,38 @@ +# frozen_string_literal: true + +# @summary Function to print deprecation warnings, Logs a warning once for a given key. +Puppet::Functions.create_function(:deprecation) do + # @param key + # 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, 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 + + # 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/lib/puppet/functions/ensure_packages.rb b/lib/puppet/functions/ensure_packages.rb new file mode 100644 index 000000000..f6f4b3ce8 --- /dev/null +++ b/lib/puppet/functions/ensure_packages.rb @@ -0,0 +1,13 @@ +# frozen_string_literal: true + +# @summary DEPRECATED. Use the namespaced function [`stdlib::ensure_packages`](#stdlibensure_packages) instead. +Puppet::Functions.create_function(:ensure_packages, Puppet::Functions::InternalFunction) do + dispatch :deprecation_gen do + scope_param + 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.', false) + scope.call_function('stdlib::ensure_packages', args) + end +end diff --git a/lib/puppet/functions/fact.rb b/lib/puppet/functions/fact.rb new file mode 100644 index 000000000..c450436ca --- /dev/null +++ b/lib/puppet/functions/fact.rb @@ -0,0 +1,65 @@ +# frozen_string_literal: true + +# @summary +# Digs into the facts hash using dot-notation +# +# 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') +# +# @example Array indexing: +# fact('mountpoints."/dev".options.1') +# +# @example Fact containing a "." in the name: +# fact('vmware."VRA.version"') +# +Puppet::Functions.create_function(:fact) do + # @param 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 + + def to_dot_syntax(array_path) + array_path.map { |string| + string.include?('.') ? %("#{string}") : string + }.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(%r{([^."]+)|(?:")([^"]+)(?:")}).map { |x| x.compact.first } + + walked_path = [] + path.reduce(facts) do |d, k| + return nil if d.nil? || k.nil? + + if d.is_a?(Array) + begin + result = d[Integer(k)] + 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 + 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}'") + result = nil + end + + walked_path << k + result + end + end +end diff --git a/lib/puppet/functions/fqdn_rand_string.rb b/lib/puppet/functions/fqdn_rand_string.rb new file mode 100644 index 000000000..1c5f5f6fe --- /dev/null +++ b/lib/puppet/functions/fqdn_rand_string.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_rand_string`](#stdlibfqdn_rand_string) instead. +Puppet::Functions.create_function(:fqdn_rand_string) do + dispatch :deprecation_gen do + 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.', false) + call_function('stdlib::fqdn_rand_string', *args) + end +end 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/has_interface_with.rb b/lib/puppet/functions/has_interface_with.rb new file mode 100644 index 000000000..bd36802c8 --- /dev/null +++ b/lib/puppet/functions/has_interface_with.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_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 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/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/functions/is_a.rb b/lib/puppet/functions/is_a.rb new file mode 100644 index 000000000..275d21815 --- /dev/null +++ b/lib/puppet/functions/is_a.rb @@ -0,0 +1,44 @@ +# 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. +# +# @example Example Usage: +# # 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 + # @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 + end + + 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 +end diff --git a/lib/puppet/functions/merge.rb b/lib/puppet/functions/merge.rb new file mode 100644 index 000000000..da42d9c92 --- /dev/null +++ b/lib/puppet/functions/merge.rb @@ -0,0 +1,15 @@ +# frozen_string_literal: true + +# THIS FILE WAS GENERATED BY `rake regenerate_unamespaced_shims` + +# @summary DEPRECATED. Use the namespaced function [`stdlib::merge`](#stdlibmerge) instead. +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, &block) + call_function('deprecation', 'merge', 'This function is deprecated, please use stdlib::merge instead.', false) + call_function('stdlib::merge', *args, &block) + end +end diff --git a/lib/puppet/functions/os_version_gte.rb b/lib/puppet/functions/os_version_gte.rb new file mode 100644 index 000000000..28da44fe0 --- /dev/null +++ b/lib/puppet/functions/os_version_gte.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::os_version_gte`](#stdlibos_version_gte) instead. +Puppet::Functions.create_function(:os_version_gte) do + dispatch :deprecation_gen do + 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.', false) + call_function('stdlib::os_version_gte', *args) + end +end diff --git a/lib/puppet/functions/parsehocon.rb b/lib/puppet/functions/parsehocon.rb new file mode 100644 index 000000000..700f685e5 --- /dev/null +++ b/lib/puppet/functions/parsehocon.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::parsehocon`](#stdlibparsehocon) instead. +Puppet::Functions.create_function(:parsehocon) do + dispatch :deprecation_gen do + repeated_param 'Any', :args + end + def deprecation_gen(*args) + 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/parsepson.rb b/lib/puppet/functions/parsepson.rb new file mode 100644 index 000000000..2eedbeee9 --- /dev/null +++ b/lib/puppet/functions/parsepson.rb @@ -0,0 +1,34 @@ +# 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 +# +# @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) + 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 + + default + end +end diff --git a/lib/puppet/functions/powershell_escape.rb b/lib/puppet/functions/powershell_escape.rb new file mode 100644 index 000000000..72209b24a --- /dev/null +++ b/lib/puppet/functions/powershell_escape.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::powershell_escape`](#stdlibpowershell_escape) instead. +Puppet::Functions.create_function(:powershell_escape) do + dispatch :deprecation_gen do + repeated_param 'Any', :args + end + def deprecation_gen(*args) + 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 new file mode 100644 index 000000000..b97c93f36 --- /dev/null +++ b/lib/puppet/functions/seeded_rand.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::seeded_rand`](#stdlibseeded_rand) instead. +Puppet::Functions.create_function(:seeded_rand) do + dispatch :deprecation_gen do + repeated_param 'Any', :args + end + def deprecation_gen(*args) + 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 new file mode 100644 index 000000000..486082547 --- /dev/null +++ b/lib/puppet/functions/seeded_rand_string.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::seeded_rand_string`](#stdlibseeded_rand_string) instead. +Puppet::Functions.create_function(:seeded_rand_string) do + dispatch :deprecation_gen do + 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.', 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 new file mode 100644 index 000000000..87af9a9af --- /dev/null +++ b/lib/puppet/functions/shell_escape.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::shell_escape`](#stdlibshell_escape) instead. +Puppet::Functions.create_function(:shell_escape) do + dispatch :deprecation_gen do + repeated_param 'Any', :args + end + def deprecation_gen(*args) + 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/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/lib/puppet/functions/stdlib/crc32.rb b/lib/puppet/functions/stdlib/crc32.rb new file mode 100644 index 000000000..73ecfa3b5 --- /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 StandardError + Zlib.crc32(my_data.to_s).to_s(16).downcase + end +end diff --git a/lib/puppet/functions/stdlib/end_with.rb b/lib/puppet/functions/stdlib/end_with.rb new file mode 100644 index 000000000..6c640890c --- /dev/null +++ b/lib/puppet/functions/stdlib/end_with.rb @@ -0,0 +1,23 @@ +# frozen_string_literal: true + +# @summary +# Returns true if str ends with one of the prefixes given. Each of the prefixes should be a String. +# +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', :test_string + param 'Variant[String[1],Array[String[1], 1]]', :suffixes + return_type 'Boolean' + end + + def end_with(test_string, suffixes) + test_string.end_with?(*suffixes) + 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/lib/puppet/functions/stdlib/extname.rb b/lib/puppet/functions/stdlib/extname.rb new file mode 100644 index 000000000..7de9d50a6 --- /dev/null +++ b/lib/puppet/functions/stdlib/extname.rb @@ -0,0 +1,28 @@ +# frozen_string_literal: true + +# @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 + # @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/lib/puppet/functions/stdlib/fqdn_rand_string.rb b/lib/puppet/functions/stdlib/fqdn_rand_string.rb new file mode 100644 index 000000000..47e436605 --- /dev/null +++ b/lib/puppet/functions/stdlib/fqdn_rand_string.rb @@ -0,0 +1,39 @@ +# 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 seed 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, undef, 'custom seed') + dispatch :fqdn_rand_string do + param 'Integer[1]', :length + optional_param 'Optional[String]', :charset + optional_repeated_param 'Any', :seed + end + + 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| + rand_string += charset[call_function('fqdn_rand', charset.size, (seed + [current + 1]).join(':'))] + end + + rand_string + 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/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/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/lib/puppet/functions/stdlib/ip_in_range.rb b/lib/puppet/functions/stdlib/ip_in_range.rb new file mode 100644 index 000000000..eed5c0b2e --- /dev/null +++ b/lib/puppet/functions/stdlib/ip_in_range.rb @@ -0,0 +1,32 @@ +# frozen_string_literal: true + +# @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 +Puppet::Functions.create_function(:'stdlib::ip_in_range') do + # @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 + 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/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/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/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/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/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/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/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/lib/puppet/functions/stdlib/sha256.rb b/lib/puppet/functions/stdlib/sha256.rb new file mode 100644 index 000000000..278568ba5 --- /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 StandardError + Digest::SHA256.hexdigest(my_data.to_s) + 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/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/lib/puppet/functions/stdlib/start_with.rb b/lib/puppet/functions/stdlib/start_with.rb new file mode 100644 index 000000000..5203baf4f --- /dev/null +++ b/lib/puppet/functions/stdlib/start_with.rb @@ -0,0 +1,23 @@ +# frozen_string_literal: true + +# @summary +# Returns true if str starts with one of the prefixes given. Each of the prefixes should be a String. +# +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', :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/str2resource.rb b/lib/puppet/functions/stdlib/str2resource.rb new file mode 100644 index 000000000..b2b586992 --- /dev/null +++ b/lib/puppet/functions/stdlib/str2resource.rb @@ -0,0 +1,35 @@ +# 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) + + 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 +end 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/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/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/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/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/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/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/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/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/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/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/functions/to_json.rb b/lib/puppet/functions/to_json.rb new file mode 100644 index 000000000..82c0534c2 --- /dev/null +++ b/lib/puppet/functions/to_json.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::to_json`](#stdlibto_json) instead. +Puppet::Functions.create_function(:to_json) do + dispatch :deprecation_gen do + repeated_param 'Any', :args + end + def deprecation_gen(*args) + 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 new file mode 100644 index 000000000..9f6dc5e5d --- /dev/null +++ b/lib/puppet/functions/to_json_pretty.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::to_json_pretty`](#stdlibto_json_pretty) instead. +Puppet::Functions.create_function(:to_json_pretty) do + dispatch :deprecation_gen do + 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.', 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 new file mode 100644 index 000000000..95045c1bb --- /dev/null +++ b/lib/puppet/functions/to_python.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::to_python`](#stdlibto_python) instead. +Puppet::Functions.create_function(:to_python) do + dispatch :deprecation_gen do + repeated_param 'Any', :args + end + def deprecation_gen(*args) + 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 new file mode 100644 index 000000000..c2d919c9b --- /dev/null +++ b/lib/puppet/functions/to_ruby.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::to_ruby`](#stdlibto_ruby) instead. +Puppet::Functions.create_function(:to_ruby) do + dispatch :deprecation_gen do + repeated_param 'Any', :args + end + def deprecation_gen(*args) + 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 new file mode 100644 index 000000000..6de87678e --- /dev/null +++ b/lib/puppet/functions/to_toml.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::to_toml`](#stdlibto_toml) instead. +Puppet::Functions.create_function(:to_toml) do + dispatch :deprecation_gen do + repeated_param 'Any', :args + end + def deprecation_gen(*args) + 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 new file mode 100644 index 000000000..980748bfa --- /dev/null +++ b/lib/puppet/functions/to_yaml.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::to_yaml`](#stdlibto_yaml) instead. +Puppet::Functions.create_function(:to_yaml) do + dispatch :deprecation_gen do + repeated_param 'Any', :args + end + def deprecation_gen(*args) + 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 new file mode 100644 index 000000000..414b361d0 --- /dev/null +++ b/lib/puppet/functions/type_of.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::type_of`](#stdlibtype_of) instead. +Puppet::Functions.create_function(:type_of) do + 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.', 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 new file mode 100644 index 000000000..04ca517a9 --- /dev/null +++ b/lib/puppet/functions/validate_domain_name.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::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 deprecation_gen(*args) + 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 new file mode 100644 index 000000000..bbc21d648 --- /dev/null +++ b/lib/puppet/functions/validate_email_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::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 deprecation_gen(*args) + 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 diff --git a/lib/puppet/functions/validate_legacy.rb b/lib/puppet/functions/validate_legacy.rb new file mode 100644 index 000000000..fb8d9c687 --- /dev/null +++ b/lib/puppet/functions/validate_legacy.rb @@ -0,0 +1,68 @@ +# frozen_string_literal: true + +# @summary +# **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). + # @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 + # @return + # A boolean value (`true` or `false`) returned from the called function. + dispatch :validate_legacy do + param 'Any', :scope + param 'Type', :target_type + param 'String', :function_name + param 'Any', :value + repeated_param 'Any', :args + end + + # @param scope + # 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 + # + dispatch :validate_legacy_s do + param 'Any', :scope + param 'String', :type_string + param 'String', :function_name + param 'Any', :value + 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) + t = Puppet::Pops::Types::TypeParser.new.parse(type_string, scope) + validate_legacy(scope, t, *args) + end + + 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) + # "Silently" passes + else + inferred_type = Puppet::Pops::Types::TypeCalculator.infer_set(value) + 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 assert_type(type, value) + Puppet::Pops::Types::TypeCalculator.instance?(type, value) + end +end diff --git a/lib/puppet/parser/functions/abs.rb b/lib/puppet/parser/functions/abs.rb deleted file mode 100644 index 11d2d7fea..000000000 --- a/lib/puppet/parser/functions/abs.rb +++ /dev/null @@ -1,36 +0,0 @@ -# -# abs.rb -# - -module Puppet::Parser::Functions - 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| - - raise(Puppet::ParseError, "abs(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") if arguments.size < 1 - - value = arguments[0] - - # Numbers in Puppet are often string-encoded which is troublesome ... - if value.is_a?(String) - if value.match(/^-?(?:\d+)(?:\.\d+){1}$/) - value = value.to_f - elsif value.match(/^-?\d+$/) - 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/lib/puppet/parser/functions/any2array.rb b/lib/puppet/parser/functions/any2array.rb index e71407e89..81efd77d7 100644 --- a/lib/puppet/parser/functions/any2array.rb +++ b/lib/puppet/parser/functions/any2array.rb @@ -1,31 +1,54 @@ +# frozen_string_literal: true + # # 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 + newfunction(:any2array, type: :rvalue, doc: <<-DOC + @summary + 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:* + 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. + + @return [Array] The new array containing the given object + DOC ) do |arguments| + return [] if arguments.empty? - if arguments.empty? - return [] - end + return arguments unless arguments.length == 1 + return arguments[0] if arguments[0].is_a?(Array) + return [] if arguments == [''] - 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 + 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 new file mode 100644 index 000000000..f32e3daea --- /dev/null +++ b/lib/puppet/parser/functions/any2bool.rb @@ -0,0 +1,54 @@ +# frozen_string_literal: true + +# +# any2bool.rb +# +module Puppet::Parser::Functions + newfunction(:any2bool, type: :rvalue, doc: <<-DOC + @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 + * 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. + + @return [Boolean] The boolean value of the object that was given + DOC + ) 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 + 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] + + return false if arg.nil? + + 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 + rescue StandardError + false + end + + return function_num2bool([arguments[0]]) if arg.is_a?(Numeric) + + if arg.is_a?(String) + return function_num2bool([arguments[0]]) if valid_float + + return function_str2bool([arguments[0]]) + end + + return true + end +end + +# vim: set ts=2 sw=2 et : diff --git a/lib/puppet/parser/functions/assert_private.rb b/lib/puppet/parser/functions/assert_private.rb new file mode 100644 index 000000000..a5f420984 --- /dev/null +++ b/lib/puppet/parser/functions/assert_private.rb @@ -0,0 +1,33 @@ +# frozen_string_literal: true + +# +# assert_private.rb +# +module Puppet::Parser::Functions + newfunction(:assert_private, doc: <<-DOC + @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| + 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].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/lib/puppet/parser/functions/base64.rb b/lib/puppet/parser/functions/base64.rb index d9a590aec..b65458e6e 100644 --- a/lib/puppet/parser/functions/base64.rb +++ b/lib/puppet/parser/functions/base64.rb @@ -1,37 +1,81 @@ +# 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 => <<-'ENDHEREDOC') 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 + + @example Example usage + + Encode and decode a string + + $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 + + $encodestring = String(Binary('thestring', '%s')) + + Decode a Binary assuming it is an UTF-8 String - Base64 encode or decode a string based on the command and the string submitted + $decodestring = String(Binary("dGhlc3RyaW5n"), "%s") - 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. - $encodestring = base64('encode','thestring') - $decodestring = base64('decode','dGhlc3RyaW5n') + @return [String] The encoded/decoded value + DOC - ENDHEREDOC - require 'base64' - - raise Puppet::ParseError, ("base64(): Wrong number of arguments (#{args.length}; must be = 2)") unless args.length == 2 - actions = ['encode','decode'] + raise Puppet::ParseError, "base64(): Wrong number of arguments (#{args.length}; must be >= 2)" unless args.length >= 2 + + actions = ['encode', 'decode'] + + raise Puppet::ParseError, "base64(): the first argument must be one of 'encode' or 'decode'" unless actions.include?(args[0]) + + raise Puppet::ParseError, 'base64(): the second argument must be a string to base64' unless args[1].is_a?(String) + + method = ['default', 'strict', 'urlsafe'] + + chosen_method = if args.length <= 2 + 'default' + else + args[2] + end + + raise Puppet::ParseError, "base64(): the third argument must be one of 'default', 'strict', or 'urlsafe'" unless method.include?(chosen_method) - 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' + when 'encode' + case chosen_method + when 'default' result = Base64.encode64(args[1]) - when 'decode' + 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 end end diff --git a/lib/puppet/parser/functions/basename.rb b/lib/puppet/parser/functions/basename.rb new file mode 100644 index 000000000..b7aa80b38 --- /dev/null +++ b/lib/puppet/parser/functions/basename.rb @@ -0,0 +1,29 @@ +# frozen_string_literal: true + +# +# basename.rb +# +module Puppet::Parser::Functions + newfunction(:basename, type: :rvalue, doc: <<-DOC + @summary + Strips directory (and optional suffix) from a filename + + @return [String] The stripped filename + 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 + 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 + end +end + +# vim: set ts=2 sw=2 et : diff --git a/lib/puppet/parser/functions/bool2num.rb b/lib/puppet/parser/functions/bool2num.rb index 9a07a8a11..066bb2b10 100644 --- a/lib/puppet/parser/functions/bool2num.rb +++ b/lib/puppet/parser/functions/bool2num.rb @@ -1,43 +1,38 @@ +# frozen_string_literal: true + # # bool2num.rb # - module Puppet::Parser::Functions - newfunction(:bool2num, :type => :rvalue, :doc => <<-EOS - Converts a boolean to a number. Converts the values: + newfunction(:bool2num, type: :rvalue, doc: <<-DOC + @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. - EOS + + > *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 + ``` + + @return [Integer] The converted value as a number + DOC ) do |arguments| + raise(Puppet::ParseError, "bool2num(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? - raise(Puppet::ParseError, "bool2num(): 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, '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/bool2str.rb b/lib/puppet/parser/functions/bool2str.rb new file mode 100644 index 000000000..f94c37e64 --- /dev/null +++ b/lib/puppet/parser/functions/bool2str.rb @@ -0,0 +1,58 @@ +# frozen_string_literal: true + +# +# bool2str.rb +# +module Puppet::Parser::Functions + newfunction(:bool2str, type: :rvalue, doc: <<-DOC + @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'. + + @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' + ``` + + 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' + ``` + DOC + ) do |arguments| + 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' + false_string = arguments[2] || 'false' + klass = value.class + + # 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?(String) + + return value ? true_string : false_string + end +end + +# vim: set ts=2 sw=2 et : diff --git a/lib/puppet/parser/functions/capitalize.rb b/lib/puppet/parser/functions/capitalize.rb deleted file mode 100644 index 640d00b82..000000000 --- a/lib/puppet/parser/functions/capitalize.rb +++ /dev/null @@ -1,34 +0,0 @@ -# -# capitalize.rb -# - -module Puppet::Parser::Functions - 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| - - raise(Puppet::ParseError, "capitalize(): 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, '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 - - return result - end -end - -# vim: set ts=2 sw=2 et : diff --git a/lib/puppet/parser/functions/chomp.rb b/lib/puppet/parser/functions/chomp.rb deleted file mode 100644 index 4564a000a..000000000 --- a/lib/puppet/parser/functions/chomp.rb +++ /dev/null @@ -1,35 +0,0 @@ -# -# chomp.rb -# - -module Puppet::Parser::Functions - 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| - - raise(Puppet::ParseError, "chomp(): 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, '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 - - return result - end -end - -# vim: set ts=2 sw=2 et : diff --git a/lib/puppet/parser/functions/chop.rb b/lib/puppet/parser/functions/chop.rb deleted file mode 100644 index f242af39c..000000000 --- a/lib/puppet/parser/functions/chop.rb +++ /dev/null @@ -1,37 +0,0 @@ -# -# chop.rb -# - -module Puppet::Parser::Functions - 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| - - raise(Puppet::ParseError, "chop(): 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, '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 - - return result - end -end - -# vim: set ts=2 sw=2 et : diff --git a/lib/puppet/parser/functions/clamp.rb b/lib/puppet/parser/functions/clamp.rb new file mode 100644 index 000000000..d95107da4 --- /dev/null +++ b/lib/puppet/parser/functions/clamp.rb @@ -0,0 +1,46 @@ +# frozen_string_literal: true + +# +# clamp.rb +# +module Puppet::Parser::Functions + 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). + + Strings are converted and compared numerically. Arrays of values are flattened + into a list for further handling. + + @example Example usage + + 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| + 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 %r{^\d+$}.match?(value) + 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(&:to_i).sort[1] + end +end diff --git a/lib/puppet/parser/functions/concat.rb b/lib/puppet/parser/functions/concat.rb index c86aa0057..af9b3eb53 100644 --- a/lib/puppet/parser/functions/concat.rb +++ b/lib/puppet/parser/functions/concat.rb @@ -1,34 +1,43 @@ +# frozen_string_literal: true + # # concat.rb # - module Puppet::Parser::Functions - newfunction(:concat, :type => :rvalue, :doc => <<-EOS -Appends the contents of array 2 onto array 1. + newfunction(:concat, type: :rvalue, doc: <<-DOC + @summary + Appends the contents of multiple arrays into array 1. -*Example:* + @example Example usage - concat(['1','2','3'],['4','5','6']) + 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'] -Would result in: + > *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'] - EOS - ) do |arguments| + `['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]]` - # Check that 2 arguments have been given ... - raise(Puppet::ParseError, "concat(): Wrong number of arguments " + - "given (#{arguments.size} for 2)") if arguments.size != 2 + @return [Array] The single concatenated array + DOC + ) 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 a = arguments[0] - b = arguments[1] - # Check that both args are arrays. - unless a.is_a?(Array) and b.is_a?(Array) - raise(Puppet::ParseError, 'concat(): Requires array to work with') - end + # Check that the first parameter is an array + raise(Puppet::ParseError, 'concat(): Requires array to work with') unless a.is_a?(Array) + + result = a + arguments.shift - result = a.concat(b) + arguments.each do |x| + result += (x.is_a?(Array) ? x : [x]) + end return result end diff --git a/lib/puppet/parser/functions/convert_base.rb b/lib/puppet/parser/functions/convert_base.rb new file mode 100644 index 000000000..b2bddd36d --- /dev/null +++ b/lib/puppet/parser/functions/convert_base.rb @@ -0,0 +1,49 @@ +# frozen_string_literal: true + +# +# convert_base.rb +# +module Puppet::Parser::Functions + 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. + + @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 + + 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) + + 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]) + + 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] + + 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 && new_base <= 36 + + return number_to_convert.to_s(new_base) + end +end diff --git a/lib/puppet/parser/functions/count.rb b/lib/puppet/parser/functions/count.rb index 52de1b8a5..8e1f7ab98 100644 --- a/lib/puppet/parser/functions/count.rb +++ b/lib/puppet/parser/functions/count.rb @@ -1,22 +1,40 @@ +# frozen_string_literal: true + +# +# 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: <<-DOC + @summary + Counts the number of elements in array. - if (args.size > 2) then - raise(ArgumentError, "count(): Wrong number of arguments "+ - "given #{args.size} for 1 or 2.") - end + 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 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. + + @return [Integer] The amount of elements counted within the array + DOC + ) do |args| + raise(ArgumentError, "count(): Wrong number of arguments given #{args.size} for 1 or 2.") if args.size > 2 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 94677b8b3..3669d4afc 100644 --- a/lib/puppet/parser/functions/deep_merge.rb +++ b/lib/puppet/parser/functions/deep_merge.rb @@ -1,26 +1,33 @@ +# frozen_string_literal: true + +# +# deep_merge.rb +# module Puppet::Parser::Functions - newfunction(:deep_merge, :type => :rvalue, :doc => <<-'ENDHEREDOC') do |args| - Recursively merges two or more hashes together and returns the resulting hash. + newfunction(:deep_merge, type: :rvalue, doc: <<-DOC) do |args| + @summary + Recursively merges two or more hashes together and returns the resulting hash. - For example: + @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 } } + $hash1 = {'one' => 1, 'two' => 2, 'three' => { 'four' => 4 } } + $hash2 = {'two' => 'dos', 'three' => { 'five' => 5 } } + $merged_hash = deep_merge($hash1, $hash2) - 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." + The resulting hash is equivalent to: - ENDHEREDOC + $merged_hash = { 'one' => 1, 'two' => 'dos', 'three' => { 'four' => 4, 'five' => 5 } } - if args.length < 2 - raise Puppet::ParseError, ("deep_merge(): wrong number of arguments (#{args.length}; must be at least 2)") - end + 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 - deep_merge = Proc.new do |hash1,hash2| - hash1.merge!(hash2) do |key,old_value,new_value| + 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| if old_value.is_a?(Hash) && new_value.is_a?(Hash) deep_merge.call(old_value, new_value) else @@ -29,16 +36,14 @@ 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" - end + raise Puppet::ParseError, "deep_merge: unexpected argument type #{arg.class}, only expects hash arguments" unless arg.is_a?(Hash) - deep_merge.call(result, arg) + 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 d7df306c7..0b8b338ee 100644 --- a/lib/puppet/parser/functions/defined_with_params.rb +++ b/lib/puppet/parser/functions/defined_with_params.rb @@ -1,35 +1,78 @@ +# frozen_string_literal: true + # Test whether a given class or definition is defined 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. +Puppet::Parser::Functions.newfunction(:defined_with_params, type: :rvalue, doc: <<-DOC + @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, } - } -ENDOFDOC + @return [Boolean] + returns `true` or `false` +DOC ) do |vals| reference, params = vals raise(ArgumentError, 'Must specify a reference') unless reference - if (! params) || params == '' - params = {} - end + + params = {} if !params || params == '' ret = false - if resource = findresource(reference.to_s) - matches = params.collect do |key, value| - resource[key] == value + + 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) + type = Puppet::Pops::Evaluator::Runtime3ResourceSupport.find_resource_type_or_class(find_global_scope, type_name.downcase) + elsif reference.is_a?(Puppet::Resource) + type = reference.type + title = reference.title + else + raise(ArgumentError, "Reference is not understood: '#{reference.class}'") + end + # end workaround + else + type = reference.to_s + title = nil + end + + resources = if title.empty? + catalog.resources.select { |r| r.type == type } + else + [findresource(type, title)] + end + + 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 + res_is_undef = res[key].eql?(:undef) || res[key].nil? + value_is_undef = value.eql?(:undef) || value.nil? + 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) + + 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/lib/puppet/parser/functions/delete.rb b/lib/puppet/parser/functions/delete.rb index d03a29355..e66b3c4c8 100644 --- a/lib/puppet/parser/functions/delete.rb +++ b/lib/puppet/parser/functions/delete.rb @@ -1,43 +1,65 @@ +# frozen_string_literal: true + # # delete.rb # +module Puppet::Parser::Functions + 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. -# TODO(Krzysztof Wilczynski): We need to add support for regular expression ... + @example Example usage -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. + delete(['a','b','c','b'], 'b') + Would return: ['a','c'] -*Examples:* + delete({'a'=>1,'b'=>2,'c'=>3}, 'b') + Would return: {'a'=>1,'c'=>3} - delete(['a','b','c','b'], 'b') - Would return: ['a','c'] + delete({'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} + delete('abracadabra', 'bra') + Would return: 'acada' - delete('abracadabra', 'bra') - Would return: 'acada' - EOS - ) do |arguments| + ['a', 'b', 'c', 'b'] - 'b' + Would return: ['a', 'c'] - if (arguments.size != 2) then - raise(Puppet::ParseError, "delete(): Wrong number of arguments "+ - "given #{arguments.size} for 2.") - end + {'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')` + + 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| + raise(Puppet::ParseError, "delete(): Wrong number of arguments given #{arguments.size} for 2") unless arguments.size == 2 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/lib/puppet/parser/functions/delete_at.rb b/lib/puppet/parser/functions/delete_at.rb index 3eb4b5375..86e7a2960 100644 --- a/lib/puppet/parser/functions/delete_at.rb +++ b/lib/puppet/parser/functions/delete_at.rb @@ -1,44 +1,52 @@ +# frozen_string_literal: true + # # 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: <<-DOC) do |arguments| + @summary + Deletes a determined indexed value from an array. + + 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 }``` -*Examples:* + 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(['a','b','c'], 1) + @return [Array] The given array, now missing the target value -Would return: ['a','c'] - EOS - ) do |arguments| + DOC - 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] - 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) and not index.match(/^\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_regex.rb b/lib/puppet/parser/functions/delete_regex.rb new file mode 100644 index 000000000..0f1417751 --- /dev/null +++ b/lib/puppet/parser/functions/delete_regex.rb @@ -0,0 +1,53 @@ +# 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. +# +module Puppet::Parser::Functions + 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. + + Multiple regular expressions are assumed to be matched as an OR. + + @example Example usage + + 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'] + + @return [Array] The given array now missing all targeted values. + DOC + ) 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/lib/puppet/parser/functions/delete_undef_values.rb b/lib/puppet/parser/functions/delete_undef_values.rb index 532639ecb..6d71e76df 100644 --- a/lib/puppet/parser/functions/delete_undef_values.rb +++ b/lib/puppet/parser/functions/delete_undef_values.rb @@ -1,33 +1,41 @@ +# frozen_string_literal: true + +# +# 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: <<-DOC + @summary + Returns a copy of input hash or array with all undefs deleted. -*Examples:* - - $hash = delete_undef_values({a=>'A', b=>'', c=>undef, d => false}) + @example Example usage -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} - $array = delete_undef_values(['A','',undef,false]) + While: + $array = delete_undef_values(['A','',undef,false]) + Would return: ['A','',false] -Would return: ['A','',false] - - EOS - ) do |args| + > *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 } - 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} ") - end - result = args[0].dup + @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? + + 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) - 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/lib/puppet/parser/functions/delete_values.rb b/lib/puppet/parser/functions/delete_values.rb index ca8eef576..4d2323082 100644 --- a/lib/puppet/parser/functions/delete_values.rb +++ b/lib/puppet/parser/functions/delete_values.rb @@ -1,26 +1,33 @@ -module Puppet::Parser::Functions - newfunction(:delete_values, :type => :rvalue, :doc => <<-EOS -Deletes all instances of a given value from a hash. +# frozen_string_literal: true -*Examples:* +# +# delete_values.rb +# +module Puppet::Parser::Functions + newfunction(:delete_values, type: :rvalue, doc: <<-DOC + @summary + Deletes all instances of a given value from a hash. - delete_values({'a'=>'A','b'=>'B','c'=>'C','B'=>'D'}, 'B') + @example Example usage -Would return: {'a'=>'A','c'=>'C','B'=>'D'} + delete_values({'a'=>'A','b'=>'B','c'=>'C','B'=>'D'}, 'B') + Would return: {'a'=>'A','c'=>'C','B'=>'D'} - EOS - ) do |arguments| + > *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' } - raise(Puppet::ParseError, - "delete_values(): Wrong number of arguments given " + - "(#{arguments.size} of 2)") if arguments.size != 2 + @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 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}.") - end - hash.dup.delete_if { |key, val| item == val } + 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 end diff --git a/lib/puppet/parser/functions/difference.rb b/lib/puppet/parser/functions/difference.rb index cd258f751..e20fc32e2 100644 --- a/lib/puppet/parser/functions/difference.rb +++ b/lib/puppet/parser/functions/difference.rb @@ -1,31 +1,38 @@ +# frozen_string_literal: true + # # 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: <<-DOC + @summary + This function returns the difference between two arrays. -*Examples:* + The returned array is a copy of the original array, removing any items that + also appear in the second array. - difference(["a","b","c"],["b","c","d"]) + @example Example usage -Would return: ["a"] - EOS - ) do |arguments| + 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 + + DOC + ) 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] - 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 ea8cc1e08..5ea1f0133 100644 --- a/lib/puppet/parser/functions/dirname.rb +++ b/lib/puppet/parser/functions/dirname.rb @@ -1,14 +1,23 @@ +# frozen_string_literal: true + +# +# dirname.rb +# module Puppet::Parser::Functions - newfunction(:dirname, :type => :rvalue, :doc => <<-EOS - Returns the dirname of a path. - EOS - ) do |arguments| + newfunction(:dirname, type: :rvalue, doc: <<-DOC + @summary + Returns the dirname of a path. - raise(Puppet::ParseError, "dirname(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") if arguments.size < 1 + @return [String] the given path's dirname + DOC + ) do |arguments| + 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 '' + raise(Puppet::ParseError, 'dirname(): Requires a non-empty string as argument') if arguments[0].empty? - path = arguments[0] - return File.dirname(path) + return File.dirname(arguments[0]) end end diff --git a/lib/puppet/parser/functions/dos2unix.rb b/lib/puppet/parser/functions/dos2unix.rb new file mode 100644 index 000000000..b55ebd4d7 --- /dev/null +++ b/lib/puppet/parser/functions/dos2unix.rb @@ -0,0 +1,18 @@ +# 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 + @summary + Returns the Unix version of the given string. + + Takes a single string argument. + + @return The retrieved version + DOC + ) do |arguments| + raise(Puppet::ParseError, 'dos2unix(): Requires string as argument') unless arguments[0].is_a?(String) + + 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 deleted file mode 100644 index 4066d210f..000000000 --- a/lib/puppet/parser/functions/downcase.rb +++ /dev/null @@ -1,33 +0,0 @@ -# -# downcase.rb -# - -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| - - raise(Puppet::ParseError, "downcase(): 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, '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 - - return result - end -end - -# vim: set ts=2 sw=2 et : diff --git a/lib/puppet/parser/functions/empty.rb b/lib/puppet/parser/functions/empty.rb deleted file mode 100644 index 80ebb86b8..000000000 --- a/lib/puppet/parser/functions/empty.rb +++ /dev/null @@ -1,28 +0,0 @@ -# -# 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 - - value = arguments[0] - klass = value.class - - unless [Array, Hash, String].include?(klass) - raise(Puppet::ParseError, 'empty(): Requires either ' + - 'array, hash or string to work with') - end - - result = value.empty? - - return result - end -end - -# vim: set ts=2 sw=2 et : diff --git a/lib/puppet/parser/functions/enclose_ipv6.rb b/lib/puppet/parser/functions/enclose_ipv6.rb new file mode 100644 index 000000000..b23561d81 --- /dev/null +++ b/lib/puppet/parser/functions/enclose_ipv6.rb @@ -0,0 +1,41 @@ +# frozen_string_literal: true + +# +# enclose_ipv6.rb +# +module Puppet::Parser::Functions + newfunction(:enclose_ipv6, type: :rvalue, doc: <<-DOC + @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| + require 'ipaddr' + + rescuable_exceptions = [ArgumentError] + rescuable_exceptions << IPAddr::InvalidAddressError if defined?(IPAddr::InvalidAddressError) + + 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 = [] + + 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}]" if ip.ipv6? + end + result << val + end + + return result.uniq + end +end diff --git a/lib/puppet/parser/functions/ensure_packages.rb b/lib/puppet/parser/functions/ensure_packages.rb deleted file mode 100644 index 1e0f225eb..000000000 --- a/lib/puppet/parser/functions/ensure_packages.rb +++ /dev/null @@ -1,25 +0,0 @@ -# -# 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. - EOS - ) do |arguments| - - 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) - packages.each { |package_name| - function_ensure_resource(['package', package_name, {'ensure' => 'present' } ]) - } - end -end - -# vim: set ts=2 sw=2 et : diff --git a/lib/puppet/parser/functions/ensure_resource.rb b/lib/puppet/parser/functions/ensure_resource.rb index 05e5593fc..48497ee54 100644 --- a/lib/puppet/parser/functions/ensure_resource.rb +++ b/lib/puppet/parser/functions/ensure_resource.rb @@ -1,34 +1,41 @@ +# frozen_string_literal: true + # Test whether a given class or definition is defined 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. +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. + + user { 'dan': + ensure => present, + } - user { 'dan': - ensure => present, - } + @return + created or recreated the passed resource with the passed type and attributes -This example only creates the resource if it does not already exist: + @example Example usage - ensure_resource('user', 'dan', {'ensure' => 'present' }) + Creates the resource if it does not already exist: -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. + ensure_resource('user', 'dan', {'ensure' => 'present' }) -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. + 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. - ensure_resource('user', ['dan','alex'], {'ensure' => 'present'}) + 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. -ENDOFDOC + ensure_resource('user', ['dan','alex'], {'ensure' => 'present'}) + +DOC ) do |vals| type, title, params = vals raise(ArgumentError, 'Must specify a type') unless type raise(ArgumentError, 'Must specify a title') unless title + params ||= {} items = [title].flatten @@ -36,8 +43,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 diff --git a/lib/puppet/parser/functions/ensure_resources.rb b/lib/puppet/parser/functions/ensure_resources.rb new file mode 100644 index 000000000..a7fc9daca --- /dev/null +++ b/lib/puppet/parser/functions/ensure_resources.rb @@ -0,0 +1,58 @@ +# frozen_string_literal: true + +require 'puppet/parser/functions' + +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. + + @return + created resources with the passed type and attributes + + @example Example usage + + 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'}) +DOC +) do |vals| + 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 + + 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 deleted file mode 100644 index a1ed18329..000000000 --- a/lib/puppet/parser/functions/flatten.rb +++ /dev/null @@ -1,33 +0,0 @@ -# -# 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. - -*Examples:* - - flatten(['a', ['b', ['c']]]) - -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 - - 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/floor.rb b/lib/puppet/parser/functions/floor.rb deleted file mode 100644 index a40192349..000000000 --- a/lib/puppet/parser/functions/floor.rb +++ /dev/null @@ -1,20 +0,0 @@ -module Puppet::Parser::Functions - 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| - - raise(Puppet::ParseError, "floor(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") if arguments.size != 1 - - arg = arguments[0] - - 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/lib/puppet/parser/functions/fqdn_rotate.rb b/lib/puppet/parser/functions/fqdn_rotate.rb deleted file mode 100644 index 655820605..000000000 --- a/lib/puppet/parser/functions/fqdn_rotate.rb +++ /dev/null @@ -1,46 +0,0 @@ -# -# 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| - - raise(Puppet::ParseError, "fqdn_rotate(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") if arguments.size < 1 - - value = arguments[0] - klass = value.class - require 'digest/md5' - - unless [Array, String].include?(klass) - raise(Puppet::ParseError, 'fqdn_rotate(): Requires either ' + - 'array or string to work with') - end - - result = value.clone - - string = value.is_a?(String) ? true : false - - # 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 - - elements = result.size - - srand(Digest::MD5.hexdigest([lookupvar('::fqdn'),arguments].join(':')).hex) - rand(elements).times { - result.push result.shift - } - - result = string ? result.join : result - - return result - end -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 new file mode 100644 index 000000000..cbe8a5652 --- /dev/null +++ b/lib/puppet/parser/functions/fqdn_uuid.rb @@ -0,0 +1,71 @@ +# frozen_string_literal: true + +require 'digest/sha1' +# +# fqdn_uuid.rb +# +module Puppet::Parser::Functions + 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 + + @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' + 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 + + fqdn = args[0] + + # 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(&: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].map do |i| + bytes.slice!(0, i).pack('C*').unpack('H*') + end + + bytes.join('-') + end +end diff --git a/lib/puppet/parser/functions/get_module_path.rb b/lib/puppet/parser/functions/get_module_path.rb index 1421b91f5..cebe550b2 100644 --- a/lib/puppet/parser/functions/get_module_path.rb +++ b/lib/puppet/parser/functions/get_module_path.rb @@ -1,17 +1,33 @@ +# frozen_string_literal: true + +# +# get_module_path.rb +# module Puppet::Parser::Functions - newfunction(:get_module_path, :type =>:rvalue, :doc => <<-EOT - Returns the absolute path of the specified module for the current - environment. + newfunction(:get_module_path, type: :rvalue, doc: <<-DOC + @summary + 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 Example Usage: $module_path = get_module_path('stdlib') - EOT + + > *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 - 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 + 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 6d510069f..ed59dcd64 100644 --- a/lib/puppet/parser/functions/getparam.rb +++ b/lib/puppet/parser/functions/getparam.rb @@ -1,35 +1,57 @@ +# frozen_string_literal: true + # Test whether a given class or definition is defined 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. +Puppet::Parser::Functions.newfunction(:getparam, type: :rvalue, doc: <<-DOC + @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. + + @example Example Usage: + + # 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''" + } -*Examples:* + # 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")) + } - define example_resource($param) { - } + # Declare an instance of the second resource type - this will call notice + example_get_param { 'show_notify': } - example_resource { "example_resource_instance": - param => "param_value" - } + Would notice: 'the value we are getting in this example' - getparam(Example_resource["example_resource_instance"], "param") + > **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 -ENDOFDOC +DOC ) 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.instance_of?(String) return '' if param.empty? - if resource = findresource(reference.to_s) - return resource[param] if resource[param] - end + resource = findresource(reference.to_s) + return resource[param] if resource && !resource[param].nil? return '' end diff --git a/lib/puppet/parser/functions/getvar.rb b/lib/puppet/parser/functions/getvar.rb deleted file mode 100644 index 162114995..000000000 --- a/lib/puppet/parser/functions/getvar.rb +++ /dev/null @@ -1,26 +0,0 @@ -module Puppet::Parser::Functions - - newfunction(:getvar, :type => :rvalue, :doc => <<-'ENDHEREDOC') do |args| - 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 - ENDHEREDOC - - unless args.length == 1 - raise Puppet::ParseError, ("getvar(): wrong number of arguments (#{args.length}; must be 1)") - end - - self.lookupvar("#{args[0]}") - - end - -end diff --git a/lib/puppet/parser/functions/glob.rb b/lib/puppet/parser/functions/glob.rb new file mode 100644 index 000000000..94bc77028 --- /dev/null +++ b/lib/puppet/parser/functions/glob.rb @@ -0,0 +1,32 @@ +# frozen_string_literal: true + +# +# glob.rb +# +module Puppet::Parser::Functions + newfunction(:glob, type: :rvalue, doc: <<-DOC + @summary + 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']) + DOC + ) do |arguments| + unless arguments.size == 1 + raise(Puppet::ParseError, 'glob(): Wrong number of arguments given ' \ + "(#{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') + end + + Dir.glob(pattern) + end +end diff --git a/lib/puppet/parser/functions/grep.rb b/lib/puppet/parser/functions/grep.rb index ceba9ecc8..4ae73c45a 100644 --- a/lib/puppet/parser/functions/grep.rb +++ b/lib/puppet/parser/functions/grep.rb @@ -1,32 +1,31 @@ +# frozen_string_literal: true + # # 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. - -*Examples:* - - grep(['aaa','bbb','ccc','aaaddd'], 'aaa') - -Would return: - - ['aaa','aaaddd'] - EOS + newfunction(:grep, type: :rvalue, doc: <<-DOC + @summary + 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'] + + > **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| - - if (arguments.size != 2) then - 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]) 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 deleted file mode 100644 index 7f150a717..000000000 --- a/lib/puppet/parser/functions/has_interface_with.rb +++ /dev/null @@ -1,52 +0,0 @@ -# -# 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 - -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 - 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 - - interfaces = lookupvar('interfaces') - - # If we do not have any interfaces, then there are no requested attributes - return false if (interfaces == :undefined) - - interfaces = interfaces.split(',') - - if args.size == 1 - return interfaces.member?(args[0]) - end - - kind, value = args - - if lookupvar(kind) == value - return true - end - - result = false - interfaces.each do |iface| - if value == lookupvar("#{kind}_#{iface}") - 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 842c8ec67..000000000 --- a/lib/puppet/parser/functions/has_ip_address.rb +++ /dev/null @@ -1,25 +0,0 @@ -# -# 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. - -This function iterates through the 'interfaces' fact and checks the -'ipaddress_IFACE' facts, performing a simple string comparison. - EOS - ) 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 9ccf9024f..000000000 --- a/lib/puppet/parser/functions/has_ip_network.rb +++ /dev/null @@ -1,25 +0,0 @@ -# -# 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. - -This function iterates through the 'interfaces' fact and checks the -'network_IFACE' facts, performing a simple string comparision. - EOS - ) 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/lib/puppet/parser/functions/has_key.rb b/lib/puppet/parser/functions/has_key.rb deleted file mode 100644 index 4657cc29c..000000000 --- a/lib/puppet/parser/functions/has_key.rb +++ /dev/null @@ -1,28 +0,0 @@ -module Puppet::Parser::Functions - - newfunction(:has_key, :type => :rvalue, :doc => <<-'ENDHEREDOC') do |args| - 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') - } - - ENDHEREDOC - - 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].has_key?(args[1]) - - end - -end diff --git a/lib/puppet/parser/functions/hash.rb b/lib/puppet/parser/functions/hash.rb deleted file mode 100644 index 8cc4823be..000000000 --- a/lib/puppet/parser/functions/hash.rb +++ /dev/null @@ -1,41 +0,0 @@ -# -# hash.rb -# - -module Puppet::Parser::Functions - newfunction(:hash, :type => :rvalue, :doc => <<-EOS -This function converts an array into a hash. - -*Examples:* - - hash(['a',1,'b',2,'c',3]) - -Would return: {'a'=>1,'b'=>2,'c'=>3} - EOS - ) do |arguments| - - raise(Puppet::ParseError, "hash(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") if arguments.size < 1 - - 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 Exception - 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/lib/puppet/parser/functions/intersection.rb b/lib/puppet/parser/functions/intersection.rb index 48f02e9d3..0f729faca 100644 --- a/lib/puppet/parser/functions/intersection.rb +++ b/lib/puppet/parser/functions/intersection.rb @@ -1,29 +1,28 @@ +# frozen_string_literal: true + # # intersection.rb # - module Puppet::Parser::Functions - newfunction(:intersection, :type => :rvalue, :doc => <<-EOS -This function returns an array an intersection of two. + newfunction(:intersection, type: :rvalue, doc: <<-DOC + @summary + This function returns an array of the intersection of two. -*Examples:* + @return + an array of the intersection of two. - intersection(["a","b","c"],["b","c","d"]) - -Would return: ["b","c"] - EOS + @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| - # 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] - unless first.is_a?(Array) && second.is_a?(Array) - raise(Puppet::ParseError, 'intersection(): Requires 2 arrays') - 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/is_array.rb b/lib/puppet/parser/functions/is_array.rb deleted file mode 100644 index b39e184ae..000000000 --- a/lib/puppet/parser/functions/is_array.rb +++ /dev/null @@ -1,22 +0,0 @@ -# -# 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. - EOS - ) do |arguments| - - raise(Puppet::ParseError, "is_array(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") if arguments.size < 1 - - type = arguments[0] - - result = type.is_a?(Array) - - 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 deleted file mode 100644 index 8bbdbc8a1..000000000 --- a/lib/puppet/parser/functions/is_bool.rb +++ /dev/null @@ -1,22 +0,0 @@ -# -# 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/is_domain_name.rb b/lib/puppet/parser/functions/is_domain_name.rb deleted file mode 100644 index 5826dc0d9..000000000 --- a/lib/puppet/parser/functions/is_domain_name.rb +++ /dev/null @@ -1,47 +0,0 @@ -# -# 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. - EOS - ) do |arguments| - - if (arguments.size != 1) then - raise(Puppet::ParseError, "is_domain_name(): Wrong number of arguments "+ - "given #{arguments.size} for 1") - end - - domain = arguments[0] - - # 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 - - # 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 /^[a-z\d-]+$/i.match(label) - end - return vlabels == labels - - end -end - -# vim: set ts=2 sw=2 et : diff --git a/lib/puppet/parser/functions/is_float.rb b/lib/puppet/parser/functions/is_float.rb deleted file mode 100644 index 911f3c2dc..000000000 --- a/lib/puppet/parser/functions/is_float.rb +++ /dev/null @@ -1,27 +0,0 @@ -# -# 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. - EOS - ) do |arguments| - - if (arguments.size != 1) then - raise(Puppet::ParseError, "is_float(): Wrong number of arguments "+ - "given #{arguments.size} for 1") - end - - value = arguments[0] - - if value != value.to_f.to_s and !value.is_a? Float then - return false - else - return true - end - - end -end - -# vim: set ts=2 sw=2 et : 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 6cbd35c3d..000000000 --- a/lib/puppet/parser/functions/is_function_available.rb +++ /dev/null @@ -1,23 +0,0 @@ -# -# 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. - EOS - ) do |arguments| - - if (arguments.size != 1) then - raise(Puppet::ParseError, "is_function_available?(): Wrong number of arguments "+ - "given #{arguments.size} for 1") - end - - function = Puppet::Parser::Functions.function(arguments[0].to_sym) - function.is_a?(String) and not function.empty? - end -end - -# vim: set ts=2 sw=2 et : diff --git a/lib/puppet/parser/functions/is_hash.rb b/lib/puppet/parser/functions/is_hash.rb deleted file mode 100644 index ad907f086..000000000 --- a/lib/puppet/parser/functions/is_hash.rb +++ /dev/null @@ -1,22 +0,0 @@ -# -# 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. - EOS - ) 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/lib/puppet/parser/functions/is_integer.rb b/lib/puppet/parser/functions/is_integer.rb deleted file mode 100644 index 6b29e988e..000000000 --- a/lib/puppet/parser/functions/is_integer.rb +++ /dev/null @@ -1,27 +0,0 @@ -# -# is_integer.rb -# - -module Puppet::Parser::Functions - newfunction(:is_integer, :type => :rvalue, :doc => <<-EOS -Returns true if the variable returned to this string is an integer. - EOS - ) do |arguments| - - if (arguments.size != 1) then - raise(Puppet::ParseError, "is_integer(): Wrong number of arguments "+ - "given #{arguments.size} for 1") - end - - value = arguments[0] - - if value != value.to_i.to_s and !value.is_a? Fixnum then - return false - else - return true - end - - end -end - -# vim: set ts=2 sw=2 et : 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 a90adabe1..000000000 --- a/lib/puppet/parser/functions/is_ip_address.rb +++ /dev/null @@ -1,32 +0,0 @@ -# -# 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. - EOS - ) do |arguments| - - require 'ipaddr' - - if (arguments.size != 1) then - 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 - - if ip.ipv4? or ip.ipv6? then - return true - else - return false - end - end -end - -# vim: set ts=2 sw=2 et : 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 1b3088a26..000000000 --- a/lib/puppet/parser/functions/is_mac_address.rb +++ /dev/null @@ -1,27 +0,0 @@ -# -# 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. - EOS - ) do |arguments| - - if (arguments.size != 1) then - raise(Puppet::ParseError, "is_mac_address(): Wrong number of arguments "+ - "given #{arguments.size} for 1") - end - - 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 - return true - else - return false - end - - end -end - -# vim: set ts=2 sw=2 et : diff --git a/lib/puppet/parser/functions/is_numeric.rb b/lib/puppet/parser/functions/is_numeric.rb deleted file mode 100644 index abf03213c..000000000 --- a/lib/puppet/parser/functions/is_numeric.rb +++ /dev/null @@ -1,27 +0,0 @@ -# -# is_numeric.rb -# - -module Puppet::Parser::Functions - newfunction(:is_numeric, :type => :rvalue, :doc => <<-EOS -Returns true if the variable passed to this function is a number. - EOS - ) do |arguments| - - if (arguments.size != 1) then - raise(Puppet::ParseError, "is_numeric(): Wrong number of arguments "+ - "given #{arguments.size} for 1") - end - - value = arguments[0] - - if value == value.to_f.to_s or value == value.to_i.to_s or value.is_a? Numeric then - return true - else - return false - end - - 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 deleted file mode 100644 index f5bef0457..000000000 --- a/lib/puppet/parser/functions/is_string.rb +++ /dev/null @@ -1,26 +0,0 @@ -# -# 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. - EOS - ) do |arguments| - - 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) - - if result and (type == type.to_f.to_s or type == type.to_i.to_s) then - return false - end - - 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 6c0a6ba02..000000000 --- a/lib/puppet/parser/functions/join.rb +++ /dev/null @@ -1,41 +0,0 @@ -# -# join.rb -# - -module Puppet::Parser::Functions - newfunction(:join, :type => :rvalue, :doc => <<-EOS -This function joins an array into a string using a separator. - -*Examples:* - - join(['a','b','c'], ",") - -Would result in: "a,b,c" - EOS - ) 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 - - 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/join_keys_to_values.rb b/lib/puppet/parser/functions/join_keys_to_values.rb index e9924fe2e..d456a4e4b 100644 --- a/lib/puppet/parser/functions/join_keys_to_values.rb +++ b/lib/puppet/parser/functions/join_keys_to_values.rb @@ -1,46 +1,52 @@ +# frozen_string_literal: true + # -# join.rb +# join_keys_to_values.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 and values are cast to strings. 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"] - EOS + 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. + + 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. + + @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"] + + @return [Hash] + The joined hash + + > **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| - # 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] - 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.") - 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] - 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.") - 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 do |k,v| - String(k) + separator + String(v) - end - + 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 + }.flatten end end diff --git a/lib/puppet/parser/functions/keys.rb b/lib/puppet/parser/functions/keys.rb deleted file mode 100644 index f0d13b647..000000000 --- a/lib/puppet/parser/functions/keys.rb +++ /dev/null @@ -1,26 +0,0 @@ -# -# keys.rb -# - -module Puppet::Parser::Functions - newfunction(:keys, :type => :rvalue, :doc => <<-EOS -Returns the keys of a hash as an array. - EOS - ) do |arguments| - - raise(Puppet::ParseError, "keys(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") if arguments.size < 1 - - 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/load_module_metadata.rb b/lib/puppet/parser/functions/load_module_metadata.rb new file mode 100644 index 000000000..d5c6672b8 --- /dev/null +++ b/lib/puppet/parser/functions/load_module_metadata.rb @@ -0,0 +1,40 @@ +# frozen_string_literal: true + +# +# load_module_metadata.rb +# +module Puppet::Parser::Functions + newfunction(:load_module_metadata, type: :rvalue, doc: <<-DOC + @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) + + 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.exist?(metadata_json) + if metadata_exists + 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 + end + + return metadata + end +end diff --git a/lib/puppet/parser/functions/loadjson.rb b/lib/puppet/parser/functions/loadjson.rb new file mode 100644 index 000000000..a85cd18ee --- /dev/null +++ b/lib/puppet/parser/functions/loadjson.rb @@ -0,0 +1,75 @@ +# frozen_string_literal: true + +# +# loadjson.rb +# + +module Puppet::Parser::Functions + 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. + + 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. + + @return [Array|String|Hash] + The data stored in the JSON file, the type depending on the type of data that was stored. + + @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 + + require 'open-uri' + begin + if args[0].start_with?('http://', 'https://') + 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_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? + PSON.load(contents) || args[1] + else + JSON.parse(contents) || args[1] + end + 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] + else + JSON.parse(content) || args[1] + end + else + warning("Can't load '#{args[0]}' File does not exist!") + args[1] + end + rescue StandardError => e + raise e unless args[1] + + args[1] + end + end +end diff --git a/lib/puppet/parser/functions/loadyaml.rb b/lib/puppet/parser/functions/loadyaml.rb index 10c400501..22bceb72b 100644 --- a/lib/puppet/parser/functions/loadyaml.rb +++ b/lib/puppet/parser/functions/loadyaml.rb @@ -1,20 +1,68 @@ +# frozen_string_literal: true + +# +# loadyaml.rb +# module Puppet::Parser::Functions + 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. - 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. + 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') - ENDHEREDOC + $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 - unless args.length == 1 - raise Puppet::ParseError, ("loadyaml(): wrong number of arguments (#{args.length}; must be 1)") - end + raise ArgumentError, 'Wrong number of arguments. 1 or 2 arguments should be provided.' unless args.length >= 1 - YAML.load_file(args[0]) + require 'yaml' + 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(url, http_basic_authentication: [username, password]) + rescue OpenURI::HTTPError => e + res = e.io + warning("Can't load '#{url}' HTTP Error Code: '#{res.status[0]}'") + args[1] + end + YAML.safe_load(contents, aliases: true) || args[1] + elsif File.exist?(args[0]) + # 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] + end + rescue StandardError => e + raise e unless args[1] + args[1] + end end - end diff --git a/lib/puppet/parser/functions/lstrip.rb b/lib/puppet/parser/functions/lstrip.rb deleted file mode 100644 index 3a64de337..000000000 --- a/lib/puppet/parser/functions/lstrip.rb +++ /dev/null @@ -1,33 +0,0 @@ -# -# lstrip.rb -# - -module Puppet::Parser::Functions - newfunction(:lstrip, :type => :rvalue, :doc => <<-EOS -Strips leading spaces to the left of a string. - EOS - ) do |arguments| - - raise(Puppet::ParseError, "lstrip(): 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, '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 - - return result - end -end - -# vim: set ts=2 sw=2 et : diff --git a/lib/puppet/parser/functions/max.rb b/lib/puppet/parser/functions/max.rb deleted file mode 100644 index 60fb94ac0..000000000 --- a/lib/puppet/parser/functions/max.rb +++ /dev/null @@ -1,21 +0,0 @@ -module Puppet::Parser::Functions - newfunction(:max, :type => :rvalue, :doc => <<-EOS - Returns the highest value of all arguments. - Requires at least one argument. - EOS - ) do |args| - - 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 - return args.max 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 - end - end -end diff --git a/lib/puppet/parser/functions/member.rb b/lib/puppet/parser/functions/member.rb index 43d76affd..b9bbeb717 100644 --- a/lib/puppet/parser/functions/member.rb +++ b/lib/puppet/parser/functions/member.rb @@ -1,41 +1,59 @@ -# -# member.rb -# +# frozen_string_literal: true # TODO(Krzysztof Wilczynski): We need to add support for regular expression ... # TODO(Krzysztof Wilczynski): Support for strings and hashes too ... - +# +# member.rb +# module Puppet::Parser::Functions - newfunction(:member, :type => :rvalue, :doc => <<-EOS -This function determines if a variable is a member of an array. - -*Examples:* - - member(['a','b'], 'b') - -Would return: true - - member(['a','b'], 'c') - -Would return: false - EOS + newfunction(:member, type: :rvalue, doc: <<-DOC + @summary + This function determines if a variable is a member of an array. + + 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. + + @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 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 + + > **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| - - 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] - 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) + + 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 = arguments[1] + 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.empty? + 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/lib/puppet/parser/functions/merge.rb b/lib/puppet/parser/functions/merge.rb index 1b39f2060..5e9d79d47 100644 --- a/lib/puppet/parser/functions/merge.rb +++ b/lib/puppet/parser/functions/merge.rb @@ -1,31 +1,36 @@ -module Puppet::Parser::Functions - newfunction(:merge, :type => :rvalue, :doc => <<-'ENDHEREDOC') do |args| - Merges two or more hashes together and returns the resulting hash. +# frozen_string_literal: true - For example: +# +# merge.rb +# +module Puppet::Parser::Functions + newfunction(:merge, type: :rvalue, doc: <<-DOC) do |args| + @summary + Merges two or more hashes together and returns the resulting hash. - $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 **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." - ENDHEREDOC + @return [Hash] + The merged hash - if args.length < 2 - raise Puppet::ParseError, ("merge(): wrong number of arguments (#{args.length}; must be at least 2)") - end + Note that since Puppet 4.0.0 the same merge can be achieved with the + operator. + `$merged_hash = $hash1 + $hash2` + DOC + + 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 = 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 - unless arg.is_a?(Hash) - raise Puppet::ParseError, "merge: unexpected argument type #{arg.class}, only expects hash arguments" - end + next if arg.is_a?(String) && arg.empty? # empty string is synonym for puppet's undef + raise Puppet::ParseError, "merge: unexpected argument type #{arg.class}, only expects hash arguments" unless arg.is_a?(Hash) + accumulator.merge!(arg) end # Return the fully merged hash diff --git a/lib/puppet/parser/functions/min.rb b/lib/puppet/parser/functions/min.rb deleted file mode 100644 index 6bd6ebf20..000000000 --- a/lib/puppet/parser/functions/min.rb +++ /dev/null @@ -1,21 +0,0 @@ -module Puppet::Parser::Functions - newfunction(:min, :type => :rvalue, :doc => <<-EOS - Returns the lowest value of all arguments. - Requires at least one argument. - EOS - ) do |args| - - 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 - 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 - end - end -end diff --git a/lib/puppet/parser/functions/num2bool.rb b/lib/puppet/parser/functions/num2bool.rb index af0e6ed78..50891df3b 100644 --- a/lib/puppet/parser/functions/num2bool.rb +++ b/lib/puppet/parser/functions/num2bool.rb @@ -1,17 +1,23 @@ +# frozen_string_literal: true + # # 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. - EOS - ) do |arguments| + newfunction(:num2bool, type: :rvalue, doc: <<-DOC + @summary + This function converts a number or a string representation of a number into a + true boolean. - raise(Puppet::ParseError, "num2bool(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") if arguments.size != 1 + > *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. + + @return [Boolean] + Boolean(0) # false for any zero or negative number + Boolean(1) # true for any positive number + DOC + ) do |arguments| + raise(Puppet::ParseError, "num2bool(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1 number = arguments[0] @@ -21,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 @@ -36,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/parsejson.rb b/lib/puppet/parser/functions/parsejson.rb index a9a16a452..fa7c66f30 100644 --- a/lib/puppet/parser/functions/parsejson.rb +++ b/lib/puppet/parser/functions/parsejson.rb @@ -1,23 +1,33 @@ +# frozen_string_literal: true + +require 'puppet/util/json' # # parsejson.rb # - 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 - ) do |arguments| + newfunction(:parsejson, type: :rvalue, doc: <<-DOC + @summary + This function accepts JSON as a string and converts it into the correct + Puppet structure. - if (arguments.size != 1) then - raise(Puppet::ParseError, "parsejson(): Wrong number of arguments "+ - "given #{arguments.size} for 1") - end + @return + convert JSON into Puppet structure - json = arguments[0] + > *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. + DOC + ) do |arguments| + raise ArgumentError, 'Wrong number of arguments. 1 or 2 arguments should be provided.' unless arguments.length >= 1 + + begin + Puppet::Util::Json.load(arguments[0]) || arguments[1] + rescue StandardError => e + raise e unless arguments[1] - # PSON is natively available in puppet - PSON.load(json) + arguments[1] + end end end diff --git a/lib/puppet/parser/functions/parseyaml.rb b/lib/puppet/parser/functions/parseyaml.rb index 53d54faff..014c12d26 100644 --- a/lib/puppet/parser/functions/parseyaml.rb +++ b/lib/puppet/parser/functions/parseyaml.rb @@ -1,23 +1,36 @@ +# frozen_string_literal: true + # # 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. - EOS - ) do |arguments| + newfunction(:parseyaml, type: :rvalue, doc: <<-DOC + @summary + This function accepts YAML as a string and converts it into the correct + Puppet structure. - if (arguments.size != 1) then - raise(Puppet::ParseError, "parseyaml(): Wrong number of arguments "+ - "given #{arguments.size} for 1") - end + @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 require 'yaml' - YAML::load(arguments[0]) + begin + 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. + 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..c344f7bbc 100644 --- a/lib/puppet/parser/functions/pick.rb +++ b/lib/puppet/parser/functions/pick.rb @@ -1,29 +1,37 @@ +# frozen_string_literal: true + +# +# pick.rb +# module Puppet::Parser::Functions - newfunction(:pick, :type => :rvalue, :doc => <<-EOS + newfunction(:pick, type: :rvalue, doc: <<-EOS + @summary + 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. -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: + 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. + EOS + ) 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? -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 + return args[0] + end end diff --git a/lib/puppet/parser/functions/pick_default.rb b/lib/puppet/parser/functions/pick_default.rb new file mode 100644 index 000000000..f1d546493 --- /dev/null +++ b/lib/puppet/parser/functions/pick_default.rb @@ -0,0 +1,43 @@ +# frozen_string_literal: true + +# +# pick_default.rb +# +module Puppet::Parser::Functions + 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. + + @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 + following: + + $real_jenkins_version = pick_default($::jenkins_version, '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. + + 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 + 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 d02286afa..4f8f0767a 100644 --- a/lib/puppet/parser/functions/prefix.rb +++ b/lib/puppet/parser/functions/prefix.rb @@ -1,42 +1,48 @@ +# frozen_string_literal: true + # # prefix.rb # - module Puppet::Parser::Functions - newfunction(:prefix, :type => :rvalue, :doc => <<-EOS -This function applies a prefix to all elements in an array. + newfunction(:prefix, type: :rvalue, doc: <<-DOC + @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'] - EOS - ) do |arguments| + > *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}" } + @return [Hash] or [Array] The passed values now contains the passed prefix + 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.size < 1 + raise(Puppet::ParseError, "prefix(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? - 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}" - 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 - end - - # Turn everything into string same as join would do ... - result = array.collect do |i| - i = i.to_s - prefix ? prefix + i : i - 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 ... + enumerable.map do |i| + i = i.to_s + prefix ? prefix + i : i + end + else + enumerable.to_h do |k, v| + k = k.to_s + [prefix ? prefix + k : k, v] + end + end return result end diff --git a/lib/puppet/parser/functions/pry.rb b/lib/puppet/parser/functions/pry.rb new file mode 100644 index 000000000..8bafe940f --- /dev/null +++ b/lib/puppet/parser/functions/pry.rb @@ -0,0 +1,37 @@ +# frozen_string_literal: true + +# +# pry.rb +# +module Puppet::Parser::Functions + 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. + + @return + debugging information + + @example **Usage** + + `pry()` + + DOC + ) 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 server' + end + end +end diff --git a/lib/puppet/parser/functions/pw_hash.rb b/lib/puppet/parser/functions/pw_hash.rb new file mode 100644 index 000000000..7bd8fd62a --- /dev/null +++ b/lib/puppet/parser/functions/pw_hash.rb @@ -0,0 +1,89 @@ +# 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. +# +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. + + 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. 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. + + > *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 +) 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 + + 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}} } + } + + 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]) + + password = args[0] + return nil if password.nil? || password.empty? + + salt = "$#{hash_type[:prefix]}$#{args[2]}" + + # handle weak implementations of String#crypt + # dup the string to get rid of frozen status for testing + 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.' + 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' + end +end diff --git a/lib/puppet/parser/functions/range.rb b/lib/puppet/parser/functions/range.rb index 0849491ac..13f93facd 100644 --- a/lib/puppet/parser/functions/range.rb +++ b/lib/puppet/parser/functions/range.rb @@ -1,85 +1,93 @@ +# frozen_string_literal: true + # # 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: <<-DOC + @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"] + NB Be explicit in including trailing zeros. Otherwise the underlying ruby function will fail. - range("host01", "host10") + > *Note:* + Passing a third argument will cause the generated range to step by that + interval, e.g. -Will return: ["host01", "host02", ..., "host09", "host10"] + The Puppet Language support Integer and Float ranges by using the type system. Those are suitable for + iterating a given number of times. -Passing a third argument will cause the generated range to step by that -interval, e.g. + @see + the step() function in Puppet for skipping values. - range("0", "9", "2") - -Will return: [0,2,4,6,8] - EOS + Integer[0, 9].each |$x| { notice($x) } # notices 0, 1, 2, ... 9 + DOC ) 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.empty? 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 ... + 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 - elsif arguments.size > 0 + 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] - - elsif value.match(/^.+$/) - raise(Puppet::ParseError, 'range(): Unable to compute range ' + - 'from the value given') + step = 1 + elsif %r{^.+$}.match?(value) + 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 start.match(/^\d+$/) - start = start.to_i - stop = stop.to_i - else - start = start.to_s - stop = stop.to_s - end + # If we were given an integer, ensure we work with one + if %r{^\d+$}.match?(start.to_s) + 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 %r{^(..|-)$} 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).first(1_000_000).to_a return result end diff --git a/lib/puppet/parser/functions/regexpescape.rb b/lib/puppet/parser/functions/regexpescape.rb new file mode 100644 index 000000000..a67138a7b --- /dev/null +++ b/lib/puppet/parser/functions/regexpescape.rb @@ -0,0 +1,32 @@ +# frozen_string_literal: true + +# +# regexpescape.rb +# +module Puppet::Parser::Functions + 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| + raise(Puppet::ParseError, "regexpescape(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty? + + value = arguments[0] + + 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 ... + value.map { |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/lib/puppet/parser/functions/reject.rb b/lib/puppet/parser/functions/reject.rb index 1953ffcf1..ecda3efed 100644 --- a/lib/puppet/parser/functions/reject.rb +++ b/lib/puppet/parser/functions/reject.rb @@ -1,30 +1,37 @@ +# frozen_string_literal: true + # # 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: <<-DOC) do |args| + @summary + This function searches through an array and rejects all elements that match + the provided regular expression. + + @return + an array containing all the elements which doesn'' match the provided regular expression -*Examples:* + @example **Usage** - reject(['aaa','bbb','ccc','aaaddd'], 'aaa') + reject(['aaa','bbb','ccc','aaaddd'], 'aaa') -Would return: + Would return: ['bbb','ccc'] - ['bbb','ccc'] -EOS + > *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) + 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] pattern = Regexp.new(args[1]) - ary.reject { |e| e =~ pattern } + ary.grep_v(pattern) end end diff --git a/lib/puppet/parser/functions/reverse.rb b/lib/puppet/parser/functions/reverse.rb index fe048690c..0cd62f246 100644 --- a/lib/puppet/parser/functions/reverse.rb +++ b/lib/puppet/parser/functions/reverse.rb @@ -1,23 +1,24 @@ +# frozen_string_literal: true + # # reverse.rb # - module Puppet::Parser::Functions - newfunction(:reverse, :type => :rvalue, :doc => <<-EOS -Reverses the order of a string or array. - EOS - ) do |arguments| + newfunction(:reverse, type: :rvalue, doc: <<-DOC + @summary + Reverses the order of a string or array. - raise(Puppet::ParseError, "reverse(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") if arguments.size < 1 + @return + reversed string or array + + > *Note:* that the same can be done with the reverse_each() function in Puppet. + DOC + ) do |arguments| + raise(Puppet::ParseError, "reverse(): 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, '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/rstrip.rb b/lib/puppet/parser/functions/rstrip.rb deleted file mode 100644 index 29b099820..000000000 --- a/lib/puppet/parser/functions/rstrip.rb +++ /dev/null @@ -1,32 +0,0 @@ -# -# rstrip.rb -# - -module Puppet::Parser::Functions - newfunction(:rstrip, :type => :rvalue, :doc => <<-EOS -Strips leading spaces to the right of the string. - EOS - ) do |arguments| - - raise(Puppet::ParseError, "rstrip(): 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, '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 - - 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..93f026e1f --- /dev/null +++ b/lib/puppet/parser/functions/shell_join.rb @@ -0,0 +1,32 @@ +# frozen_string_literal: true + +require 'shellwords' +# +# shell_join.rb +# +module Puppet::Parser::Functions + 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. + This function behaves the same as ruby's Shellwords.shelljoin() function + + @return + a command line string + DOC + ) 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(&: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..1fa3c8ed3 --- /dev/null +++ b/lib/puppet/parser/functions/shell_split.rb @@ -0,0 +1,28 @@ +# frozen_string_literal: true + +require 'shellwords' +# +# shell_split.rb +# +module Puppet::Parser::Functions + newfunction(:shell_split, type: :rvalue, doc: <<-DOC + @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 + ) 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/lib/puppet/parser/functions/shuffle.rb b/lib/puppet/parser/functions/shuffle.rb index 18134ab63..c2c420ebf 100644 --- a/lib/puppet/parser/functions/shuffle.rb +++ b/lib/puppet/parser/functions/shuffle.rb @@ -1,33 +1,32 @@ +# frozen_string_literal: true + # # 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: <<-DOC + @summary + Randomizes the order of a string or array elements. - raise(Puppet::ParseError, "shuffle(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") if arguments.size < 1 + @return + randomized string or array + DOC + ) do |arguments| + raise(Puppet::ParseError, "shuffle(): 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, '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 - 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/size.rb b/lib/puppet/parser/functions/size.rb deleted file mode 100644 index cc207e3fa..000000000 --- a/lib/puppet/parser/functions/size.rb +++ /dev/null @@ -1,48 +0,0 @@ -# -# 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. - EOS - ) do |arguments| - - raise(Puppet::ParseError, "size(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") if arguments.size < 1 - - item = arguments[0] - - 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 or array to work with') - - rescue ArgumentError - result = item.size - end - - elsif item.is_a?(Array) - 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/lib/puppet/parser/functions/sort.rb b/lib/puppet/parser/functions/sort.rb deleted file mode 100644 index cefbe5463..000000000 --- a/lib/puppet/parser/functions/sort.rb +++ /dev/null @@ -1,27 +0,0 @@ -# -# sort.rb -# - -module Puppet::Parser::Functions - newfunction(:sort, :type => :rvalue, :doc => <<-EOS -Sorts strings and arrays lexically. - EOS - ) do |arguments| - - if (arguments.size != 1) then - raise(Puppet::ParseError, "sort(): Wrong number of arguments "+ - "given #{arguments.size} for 1") - end - - value = arguments[0] - - if value.is_a?(Array) then - value.sort - elsif value.is_a?(String) then - value.split("").sort.join("") - end - - end -end - -# vim: set ts=2 sw=2 et : diff --git a/lib/puppet/parser/functions/squeeze.rb b/lib/puppet/parser/functions/squeeze.rb index 81fadfdb2..ee527c4d2 100644 --- a/lib/puppet/parser/functions/squeeze.rb +++ b/lib/puppet/parser/functions/squeeze.rb @@ -1,35 +1,33 @@ +# frozen_string_literal: true + # # 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: <<-DOC + @summary + Returns a new string where runs of the same character that occur in this set are replaced by a single character. - if ((arguments.size != 2) and (arguments.size != 1)) then - raise(Puppet::ParseError, "squeeze(): Wrong number of arguments "+ - "given #{arguments.size} for 2 or 1") - end + @return + a new string where runs of the same character that occur in this set are replaced by a single character. + DOC + ) do |arguments| + 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] - 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(&: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 fece7a6f2..f2cb42ba6 100644 --- a/lib/puppet/parser/functions/str2bool.rb +++ b/lib/puppet/parser/functions/str2bool.rb @@ -1,43 +1,43 @@ +# frozen_string_literal: true + # # 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, 1, t, true to 'true' and strings that contain things -like: 0, f, n, false, no to 'false'. - EOS - ) do |arguments| + newfunction(:str2bool, type: :rvalue, doc: <<-DOC + @summary + This converts a string to a boolean. - raise(Puppet::ParseError, "str2bool(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") if arguments.size < 1 + @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| + 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 - 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 either ' + - '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 - # - # 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, '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/str2saltedpbkdf2.rb b/lib/puppet/parser/functions/str2saltedpbkdf2.rb new file mode 100644 index 000000000..5640832dd --- /dev/null +++ b/lib/puppet/parser/functions/str2saltedpbkdf2.rb @@ -0,0 +1,70 @@ +# 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. +# +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', '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'], + } + + @example Sensitive password and salt + $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'], + } + + @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.new('SHA512') + hash = OpenSSL::PKCS5.pbkdf2_hmac(password, salt, iterations, keylen, digest) + + { + '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 7fe7b0128..4d4800e8a 100644 --- a/lib/puppet/parser/functions/str2saltedsha512.rb +++ b/lib/puppet/parser/functions/str2saltedsha512.rb @@ -1,31 +1,35 @@ +# frozen_string_literal: true + # -# 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 - 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 + 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). + + @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 ) 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}") - 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") + 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/strftime.rb b/lib/puppet/parser/functions/strftime.rb deleted file mode 100644 index 0b52adecd..000000000 --- a/lib/puppet/parser/functions/strftime.rb +++ /dev/null @@ -1,107 +0,0 @@ -# -# strftime.rb -# - -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 - EOS - ) 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 - - 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 and not 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/lib/puppet/parser/functions/strip.rb b/lib/puppet/parser/functions/strip.rb deleted file mode 100644 index 5f4630d7d..000000000 --- a/lib/puppet/parser/functions/strip.rb +++ /dev/null @@ -1,39 +0,0 @@ -# -# 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. - -*Examples:* - - strip(" aaa ") - -Would result in: "aaa" - EOS - ) do |arguments| - - raise(Puppet::ParseError, "strip(): 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, '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 - - return result - end -end - -# vim: set ts=2 sw=2 et : diff --git a/lib/puppet/parser/functions/suffix.rb b/lib/puppet/parser/functions/suffix.rb index f7792d6f7..34db43833 100644 --- a/lib/puppet/parser/functions/suffix.rb +++ b/lib/puppet/parser/functions/suffix.rb @@ -1,42 +1,52 @@ +# frozen_string_literal: true + # # suffix.rb # - module Puppet::Parser::Functions - newfunction(:suffix, :type => :rvalue, :doc => <<-EOS -This function applies a suffix to all elements in an array. + 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. -*Examples:* + @return + Array or Hash with updated elements containing the passed suffix - suffix(['a','b','c'], 'p') + @example **Usage** -Will return: ['ap','bp','cp'] - EOS - ) do |arguments| + 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| # 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? - 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}" - 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 - end - - # Turn everything into string same as join would do ... - result = array.collect do |i| - i = i.to_s - suffix ? i + suffix : i - 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 ... + enumerable.map do |i| + i = i.to_s + suffix ? i + suffix : i + end + else + enumerable.to_h 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 b9e663253..a640f0272 100644 --- a/lib/puppet/parser/functions/swapcase.rb +++ b/lib/puppet/parser/functions/swapcase.rb @@ -1,36 +1,35 @@ +# 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. # - 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: <<-DOC + @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" - EOS + swapcase("aBcD") + Would result in: "AbCd" + DOC ) 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] - klass = value.class - - unless [Array, String].include?(klass) - 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 + + 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 ... + 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 deleted file mode 100644 index 0cddaf86b..000000000 --- a/lib/puppet/parser/functions/time.rb +++ /dev/null @@ -1,49 +0,0 @@ -# -# time.rb -# - -module Puppet::Parser::Functions - newfunction(:time, :type => :rvalue, :doc => <<-EOS -This function will return the current time since epoch as an integer. - -*Examples:* - - time() - -Will return something like: 1311972653 - EOS - ) do |arguments| - - # The Time Zone argument is optional ... - 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") - end - - time = Time.new - - # There is probably a better way to handle Time Zone ... - if time_zone and not 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 - - # 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 - end -end - -# vim: set ts=2 sw=2 et : diff --git a/lib/puppet/parser/functions/to_bytes.rb b/lib/puppet/parser/functions/to_bytes.rb index 8ff73d10b..9b903db77 100644 --- a/lib/puppet/parser/functions/to_bytes.rb +++ b/lib/puppet/parser/functions/to_bytes.rb @@ -1,27 +1,38 @@ +# frozen_string_literal: true + +# +# to_bytes.rb +# module Puppet::Parser::Functions - newfunction(:to_bytes, :type => :rvalue, :doc => <<-EOS - Converts the argument into bytes, for example 4 kB becomes 4096. + newfunction(:to_bytes, type: :rvalue, doc: <<-DOC + @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. - EOS + 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| - - 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] 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 'E' then return (value*(1<<50)).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/type.rb b/lib/puppet/parser/functions/type.rb deleted file mode 100644 index 8d85f1158..000000000 --- a/lib/puppet/parser/functions/type.rb +++ /dev/null @@ -1,50 +0,0 @@ -# -# type.rb -# - -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 - 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 ... - - # 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/lib/puppet/parser/functions/union.rb b/lib/puppet/parser/functions/union.rb index c91bb8053..eb2c9f0ce 100644 --- a/lib/puppet/parser/functions/union.rb +++ b/lib/puppet/parser/functions/union.rb @@ -1,33 +1,29 @@ +# frozen_string_literal: true + # # union.rb # - module Puppet::Parser::Functions - newfunction(:union, :type => :rvalue, :doc => <<-EOS -This function returns a union of two arrays. - -*Examples:* + newfunction(:union, type: :rvalue, doc: <<-DOC + @summary + This function returns a union of two or more arrays. - union(["a","b","c"],["b","c","d"]) + @return + a unionized array of two or more arrays + @example **Usage** -Would return: ["a","b","c","d"] - EOS + union(["a","b","c"],["b","c","d"]) + Would return: ["a","b","c","d"] + 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 - # Two arguments are required - raise(Puppet::ParseError, "union(): Wrong number of arguments " + - "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/lib/puppet/parser/functions/unique.rb b/lib/puppet/parser/functions/unique.rb deleted file mode 100644 index 8844a7418..000000000 --- a/lib/puppet/parser/functions/unique.rb +++ /dev/null @@ -1,51 +0,0 @@ -# -# unique.rb -# - -module Puppet::Parser::Functions - newfunction(:unique, :type => :rvalue, :doc => <<-EOS -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"] - EOS - ) do |arguments| - - raise(Puppet::ParseError, "unique(): 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, '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/lib/puppet/parser/functions/unix2dos.rb b/lib/puppet/parser/functions/unix2dos.rb new file mode 100644 index 000000000..4dd4c5662 --- /dev/null +++ b/lib/puppet/parser/functions/unix2dos.rb @@ -0,0 +1,19 @@ +# 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 + @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| + raise(Puppet::ParseError, 'unix2dos(): Requires string as argument') unless arguments[0].is_a?(String) + + 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 deleted file mode 100644 index fe6cadc3c..000000000 --- a/lib/puppet/parser/functions/upcase.rb +++ /dev/null @@ -1,41 +0,0 @@ -# -# upcase.rb -# - -module Puppet::Parser::Functions - newfunction(:upcase, :type => :rvalue, :doc => <<-EOS -Converts a string or an array of strings to uppercase. - -*Examples:* - - upcase("abcd") - -Will return: - - ASDF - EOS - ) do |arguments| - - raise(Puppet::ParseError, "upcase(): 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, 'upcase(): 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.upcase : i } - else - result = value.upcase - end - - return result - end -end - -# vim: set ts=2 sw=2 et : diff --git a/lib/puppet/parser/functions/uriescape.rb b/lib/puppet/parser/functions/uriescape.rb index 0d81de5d1..128558163 100644 --- a/lib/puppet/parser/functions/uriescape.rb +++ b/lib/puppet/parser/functions/uriescape.rb @@ -1,32 +1,39 @@ +# frozen_string_literal: true + +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. +# 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. # -require 'uri' - module Puppet::Parser::Functions - 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 + 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. + + @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.size < 1 + raise(Puppet::ParseError, "uriescape(): 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, '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,unsafe) : i } - else - result = URI.escape(value) - 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 ... + value.map { |i| i.is_a?(String) ? URI::DEFAULT_PARSER.escape(i) : i } + else + URI::DEFAULT_PARSER.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 deleted file mode 100644 index fe279744e..000000000 --- a/lib/puppet/parser/functions/validate_absolute_path.rb +++ /dev/null @@ -1,56 +0,0 @@ -module Puppet::Parser::Functions - 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. - - 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) - - ENDHEREDOC - - require 'puppet/util' - - unless args.length > 0 then - raise Puppet::ParseError, ("validate_absolute_path(): wrong number of arguments (#{args.length}; must be > 0)") - 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.") - 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 -end diff --git a/lib/puppet/parser/functions/validate_array.rb b/lib/puppet/parser/functions/validate_array.rb deleted file mode 100644 index 34b511825..000000000 --- a/lib/puppet/parser/functions/validate_array.rb +++ /dev/null @@ -1,33 +0,0 @@ -module Puppet::Parser::Functions - - 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. - - 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) - - ENDHEREDOC - - unless args.length > 0 then - 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/lib/puppet/parser/functions/validate_augeas.rb b/lib/puppet/parser/functions/validate_augeas.rb index 154d66091..31df4cd66 100644 --- a/lib/puppet/parser/functions/validate_augeas.rb +++ b/lib/puppet/parser/functions/validate_augeas.rb @@ -1,6 +1,15 @@ +# frozen_string_literal: true + +require 'tempfile' + +# +# validate_augaes.rb +# module Puppet::Parser::Functions - newfunction(:validate_augeas, :doc => <<-'ENDHEREDOC') 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 @@ -10,41 +19,45 @@ 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') - ENDHEREDOC + DOC + ) do |args| 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 - 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}" 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 @@ -54,16 +67,16 @@ module Puppet::Parser::Functions # Check for syntax lens = args[1] aug.transform( - :lens => lens, - :name => 'Validate_augeas', - :incl => tmpfile.path + 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 @@ -71,7 +84,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 deleted file mode 100644 index 59a08056b..000000000 --- a/lib/puppet/parser/functions/validate_bool.rb +++ /dev/null @@ -1,34 +0,0 @@ -module Puppet::Parser::Functions - - 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. - - 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) - - ENDHEREDOC - - unless args.length > 0 then - 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/lib/puppet/parser/functions/validate_cmd.rb b/lib/puppet/parser/functions/validate_cmd.rb index 2ebe91cf7..c82952a2b 100644 --- a/lib/puppet/parser/functions/validate_cmd.rb +++ b/lib/puppet/parser/functions/validate_cmd.rb @@ -1,27 +1,40 @@ +# frozen_string_literal: true + require 'puppet/util/execution' +require 'tempfile' +# +# validate_cmd.rb +# module Puppet::Parser::Functions - newfunction(:validate_cmd, :doc => <<-'ENDHEREDOC') 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 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. + @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 validate_cmd($sudoerscontent, '/usr/sbin/visudo -c -f', 'Visudo failed to validate sudoers 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)") - end + % as file location + validate_cmd($haproxycontent, '/usr/sbin/haproxy -f % -c', 'Haproxy failed to validate config content') + + DOC + ) do |args| + 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}" @@ -29,17 +42,27 @@ 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 Puppet::Util::Execution.respond_to?('execute') - Puppet::Util::Execution.execute("#{checkscript} #{tmpfile.path}") + + check_with_correct_location = if %r{\s%(\s|$)}.match?(checkscript) + 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) else - Puppet::Util.execute("#{checkscript} #{tmpfile.path}") + 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 => e + msg += "\n#{e.class.name} #{e}" raise Puppet::ParseError, msg ensure tmpfile.unlink diff --git a/lib/puppet/parser/functions/validate_hash.rb b/lib/puppet/parser/functions/validate_hash.rb deleted file mode 100644 index 9bdd54328..000000000 --- a/lib/puppet/parser/functions/validate_hash.rb +++ /dev/null @@ -1,33 +0,0 @@ -module Puppet::Parser::Functions - - 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. - - 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) - - ENDHEREDOC - - unless args.length > 0 then - 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/lib/puppet/parser/functions/validate_ipv4_address.rb b/lib/puppet/parser/functions/validate_ipv4_address.rb deleted file mode 100644 index fc02748e8..000000000 --- a/lib/puppet/parser/functions/validate_ipv4_address.rb +++ /dev/null @@ -1,48 +0,0 @@ -module Puppet::Parser::Functions - - newfunction(:validate_ipv4_address, :doc => <<-ENDHEREDOC - 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) - - 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_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/lib/puppet/parser/functions/validate_ipv6_address.rb b/lib/puppet/parser/functions/validate_ipv6_address.rb deleted file mode 100644 index b0f2558df..000000000 --- a/lib/puppet/parser/functions/validate_ipv6_address.rb +++ /dev/null @@ -1,49 +0,0 @@ -module Puppet::Parser::Functions - - newfunction(:validate_ipv6_address, :doc => <<-ENDHEREDOC - 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) - - 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_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/lib/puppet/parser/functions/validate_re.rb b/lib/puppet/parser/functions/validate_re.rb deleted file mode 100644 index ca25a702c..000000000 --- a/lib/puppet/parser/functions/validate_re.rb +++ /dev/null @@ -1,40 +0,0 @@ -module Puppet::Parser::Functions - 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 - (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') - - 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)") - end - - 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/lib/puppet/parser/functions/validate_slength.rb b/lib/puppet/parser/functions/validate_slength.rb deleted file mode 100644 index 7d534f370..000000000 --- a/lib/puppet/parser/functions/validate_slength.rb +++ /dev/null @@ -1,71 +0,0 @@ -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 - 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,10) - - ENDHEREDOC - - 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 - - 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 - - if min_length > max_length - raise Puppet::ParseError, "validate_slength(): Expected second argument to be larger than third argument" - end - - validator = lambda do |str| - unless str.length <= max_length and 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| - 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 - 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/lib/puppet/parser/functions/validate_string.rb b/lib/puppet/parser/functions/validate_string.rb deleted file mode 100644 index e667794a6..000000000 --- a/lib/puppet/parser/functions/validate_string.rb +++ /dev/null @@ -1,33 +0,0 @@ -module Puppet::Parser::Functions - - 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. - - 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' ]) - $undefined = undef - validate_string($undefined) - - ENDHEREDOC - - unless args.length > 0 then - raise Puppet::ParseError, ("validate_string(): 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. 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 new file mode 100644 index 000000000..48fbfe30a --- /dev/null +++ b/lib/puppet/parser/functions/validate_x509_rsa_key_pair.rb @@ -0,0 +1,49 @@ +# frozen_string_literal: true + +# +# validate_x509_rsa_key_pair.rb +# +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. + + @return + Fail compilation if any value fails this check. + + ```validate_x509_rsa_key_pair($cert, $key)``` + + DOC + ) do |args| + require 'openssl' + + NUM_ARGS = 2 unless defined? NUM_ARGS + + unless args.length == NUM_ARGS + raise Puppet::ParseError, + "validate_x509_rsa_key_pair(): wrong number of arguments (#{args.length}; must be #{NUM_ARGS})" + end + + args.each do |arg| + raise Puppet::ParseError, "#{arg.inspect} is not a string." unless arg.is_a?(String) + 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 + + raise Puppet::ParseError, 'Certificate signature does not match supplied key' unless cert.verify(key) + end +end diff --git a/lib/puppet/parser/functions/values.rb b/lib/puppet/parser/functions/values.rb deleted file mode 100644 index 16067561b..000000000 --- a/lib/puppet/parser/functions/values.rb +++ /dev/null @@ -1,39 +0,0 @@ -# -# 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. - -*Examples:* - - $hash = { - 'a' => 1, - 'b' => 2, - 'c' => 3, - } - values($hash) - -This example would return: - - [1,2,3] - EOS - ) do |arguments| - - raise(Puppet::ParseError, "values(): Wrong number of arguments " + - "given (#{arguments.size} for 1)") if arguments.size < 1 - - 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/lib/puppet/parser/functions/values_at.rb b/lib/puppet/parser/functions/values_at.rb index d3e69d97f..a3e69e065 100644 --- a/lib/puppet/parser/functions/values_at.rb +++ b/lib/puppet/parser/functions/values_at.rb @@ -1,95 +1,89 @@ +# frozen_string_literal: true + # # 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: <<-DOC + @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: + 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*: + @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"]) + > *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 ['a','c','d']. - EOS - ) do |arguments| + `['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']` - raise(Puppet::ParseError, "values_at(): Wrong number of " + - "arguments given (#{arguments.size} for 2)") if arguments.size < 2 + DOC + ) do |arguments| + raise(Puppet::ParseError, "values_at(): Wrong number of arguments given (#{arguments.size} for 2)") if arguments.size < 2 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 ... + 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') - end + raise(Puppet::ParseError, 'values_at(): You must provide at least one positive index to collect') if !indices || indices.empty? - result = [] indices_list = [] indices.each do |i| - if m = i.match(/^(\d+)(\.\.\.?|\-)(\d+)$/) + i = i.to_s + 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+$/) - 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 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 2b56e9ca0..40323b7de 100644 --- a/lib/puppet/parser/functions/zip.rb +++ b/lib/puppet/parser/functions/zip.rb @@ -1,59 +1,30 @@ +# frozen_string_literal: true + # # 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. - -*Example:* - - zip(['1','2','3'],['4','5','6']) + newfunction(:zip, type: :rvalue, doc: <<-DOC + @summary + Takes one element from first array and merges corresponding elements from second array. -Would result in: + @return + This generates a sequence of n-element arrays, where n is one more than the count of arguments. - ["1", "4"], ["2", "5"], ["3", "6"] - EOS + @example + zip(['1','2','3'],['4','5','6']) + Would result in: ["1", "4"], ["2", "5"], ["3", "6"] + 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 + raise(Puppet::ParseError, "zip(): Wrong number of arguments given (#{arguments.size} for 2)") if arguments.size < 2 a = arguments[0] b = arguments[1] - unless a.is_a?(Array) and b.is_a?(Array) - raise(Puppet::ParseError, 'zip(): Requires array to work with') - end - - 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) - raise(Puppet::ParseError, 'zip(): Requires either ' + - 'boolean or string to work with') - end + raise(Puppet::ParseError, 'zip(): Requires array to work with') unless a.is_a?(Array) && b.is_a?(Array) - 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 diff --git a/lib/puppet/provider/file_line/ruby.rb b/lib/puppet/provider/file_line/ruby.rb index 94e7fac91..4269f16ec 100644 --- a/lib/puppet/provider/file_line/ruby.rb +++ b/lib/puppet/provider/file_line/ruby.rb @@ -1,83 +1,170 @@ +# frozen_string_literal: true + 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? - lines.find do |line| - line.chomp == resource[:line].chomp + found = false + lines_count = 0 + lines.each do |line| + found = line.chomp == resource[:line] + lines_count += 1 if found end + 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 + else + !(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 + elsif lines_count.zero? + resource[:replace].to_s == 'false' + else + true + end + elsif match_count.zero? + if lines_count.zero? + false + else + true + end + elsif lines_count.zero? + resource[:match_for_absence].to_s == 'true' + else + true + end end def create + return if resource[:replace].to_s != 'true' && count_matches(new_match_regex).positive? + if resource[:match] handle_create_with_match elsif resource[:after] handle_create_with_after else - append_line + handle_append_line end 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' && resource[:match] + handle_destroy_with_match + else + handle_destroy_line end 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 # 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]) + rescue TypeError => _e + # Ruby 1.8 doesn't support open_args @lines ||= File.readlines(resource[:path]) + rescue Errno::ENOENT + raise unless resource.noop? + + @lines ||= [] end - def handle_create_with_match() - regex = resource[:match] ? Regexp.new(resource[:match]) : nil - match_count = lines.select { |l| regex.match(l) }.size - if match_count > 1 && resource[:multiple].to_s != 'true' - raise Puppet::Error, "More than one line in file '#{resource[:path]}' matches pattern '#{resource[:match]}'" + 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.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 end + end + + def handle_create_with_match + after_regex = new_after_regex + match_regex = new_match_regex + match_count = count_matches(new_match_regex) + + 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 |l| - fh.puts(regex.match(l) ? resource[:line] : l) - end + lines.each do |line| + fh.puts(match_regex.match(line) ? resource[:line] : line) + next unless match_count.zero? && after_regex - if (match_count == 0) - fh.puts(resource[:line]) + 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 + + fh.puts(resource[:line]) if match_count.zero? end end 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 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 - end + after_regex = new_after_regex + after_count = count_matches(after_regex) + + 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 |line| + fh.puts(line) + fh.puts(resource[:line]) if after_regex.match(line) 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." + + fh.puts(resource[:line]) if after_count.zero? end end - ## - # append the line to the file. - # - # @api private - def append_line - File.open(resource[:path], 'a') do |fh| - fh.puts resource[:line] + def handle_destroy_with_match + match_regex = new_match_regex + match_count = count_matches(match_regex) + 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) + end + + def handle_destroy_line + local_lines = lines + File.write(resource[:path], local_lines.reject { |line| line.chomp == resource[:line] }.join) + end + + def handle_append_line + local_lines = lines + File.open(resource[:path], 'w') do |fh| + local_lines.each do |line| + fh.puts(line) + end + fh.puts(resource[:line]) end end end diff --git a/lib/puppet/type/anchor.rb b/lib/puppet/type/anchor.rb index fe1e5aa19..64a111e49 100644 --- a/lib/puppet/type/anchor.rb +++ b/lib/puppet/type/anchor.rb @@ -1,6 +1,11 @@ +# frozen_string_literal: true + Puppet::Type.newtype(:anchor) do - desc <<-'ENDOFDESC' - A simple resource type intended to be used as an anchor in a composite class. + desc <<-DOC + @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 @@ -12,32 +17,35 @@ 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': } + ``` - ENDOFDESC + DOC newparam :name do - desc "The name of the anchor resource." + 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 323fc4c9c..bcb74f3fa 100644 --- a/lib/puppet/type/file_line.rb +++ b/lib/puppet/type/file_line.rb @@ -1,79 +1,194 @@ -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 - 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. - - 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', - } +# frozen_string_literal: true +Puppet::Type.newtype(:file_line) do + desc <<-DOC + @summary + 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. + + * Ensure 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. - EOT + * 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:* + 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. + DOC ensurable do + desc 'Manage the state of this type.' defaultvalues 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 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 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.' + 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 - newparam(:line) do - desc 'The line to be appended to the file located by the path parameter.' + # 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 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}'") - end + raise Puppet::Error, "File paths must be fully qualified, not '#{value}'" unless Puppet::Util.absolute_path?(value) end end + 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 + + 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' + 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] end - validate do - 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 + 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' + 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/lib/puppet_x/stdlib.rb b/lib/puppet_x/stdlib.rb new file mode 100644 index 000000000..dbbe7cbc1 --- /dev/null +++ b/lib/puppet_x/stdlib.rb @@ -0,0 +1,6 @@ +# frozen_string_literal: true + +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..e287bc1cc --- /dev/null +++ b/lib/puppet_x/stdlib/toml_dumper.rb @@ -0,0 +1,135 @@ +# 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_relative '../../puppet_x/stdlib' +require 'date' + +# 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 + + 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 + + print_prefix prefix, extra_brackets if prefix.any? && (simple_pairs.any? || hash.empty?) + + 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" + 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 diff --git a/manifests/init.pp b/manifests/init.pp index 500ad770d..987c6d8e3 100644 --- a/manifests/init.pp +++ b/manifests/init.pp @@ -1,20 +1,13 @@ -# 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 and stdlib::manage. # class stdlib { - - class { 'stdlib::stages': } - + include stdlib::manage + include stdlib::stages } diff --git a/manifests/manage.pp b/manifests/manage.pp new file mode 100644 index 000000000..82c39bc8d --- /dev/null +++ b/manifests/manage.pp @@ -0,0 +1,118 @@ +# @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`. +# +# @param create_resources +# A hash of resources to create +# 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', +# 'epp' => { +# 'template' => 'profile/motd.epp', +# } +# }, +# '/etc/information' => { +# 'ensure' => 'file', +# 'erb' => { +# 'template' => 'profile/informaiton.erb', +# } +# } +# }, +# 'package' => { +# 'example' => { +# 'ensure' => 'installed', +# 'subscribe' => ['Service[sshd]', 'Exec[something]'], +# } +# } +# } +# } +# +# @example +# stdlib::manage::create_resources: +# file: +# '/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 +# subscribe: +# - 'Service[sshd]' +# - 'Exec[something]' +class stdlib::manage ( + Hash[String, Hash] $create_resources = {} +) { + $create_resources.each |$type, $resources| { + $resources.each |$title, $attributes| { + case $type { + 'file': { + # 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 '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 - 'erb' - 'epp' - 'content', + content => $content, + } + } + default: { + create_resources($type, { $title => $attributes }) + } + } + } + } +} diff --git a/manifests/stages.pp b/manifests/stages.pp index eb15fd650..0ebf596be 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,24 +15,13 @@ # * 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 { - stage { 'setup': before => Stage['main'] } stage { 'runtime': require => Stage['main'] } -> stage { 'setup_infra': } @@ -39,5 +29,4 @@ -> stage { 'setup_app': } -> stage { 'deploy_app': } -> stage { 'deploy': } - } diff --git a/metadata.json b/metadata.json new file mode 100644 index 000000000..c997c0457 --- /dev/null +++ b/metadata.json @@ -0,0 +1,119 @@ +{ + "name": "puppetlabs-stdlib", + "version": "9.7.0", + "author": "puppetlabs", + "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", + "issues_url": "https://github.com/puppetlabs/puppetlabs-stdlib/issues", + "dependencies": [ + + ], + "operatingsystem_support": [ + { + "operatingsystem": "RedHat", + "operatingsystemrelease": [ + "7", + "8", + "9" + ] + }, + { + "operatingsystem": "CentOS", + "operatingsystemrelease": [ + "7", + "8" + ] + }, + { + "operatingsystem": "OracleLinux", + "operatingsystemrelease": [ + "7" + ] + }, + { + "operatingsystem": "Scientific", + "operatingsystemrelease": [ + "7" + ] + }, + { + "operatingsystem": "SLES", + "operatingsystemrelease": [ + "12", + "15" + ] + }, + { + "operatingsystem": "Debian", + "operatingsystemrelease": [ + "10", + "11", + "12" + ] + }, + { + "operatingsystem": "Ubuntu", + "operatingsystemrelease": [ + "18.04", + "20.04", + "22.04", + "24.04" + ] + }, + { + "operatingsystem": "Solaris", + "operatingsystemrelease": [ + "11" + ] + }, + { + "operatingsystem": "Windows", + "operatingsystemrelease": [ + "10", + "2012", + "2012 R2", + "2016", + "2019", + "2022" + ] + }, + { + "operatingsystem": "AIX", + "operatingsystemrelease": [ + "7.1", + "7.2" + ] + }, + { + "operatingsystem": "Rocky", + "operatingsystemrelease": [ + "8" + ] + }, + { + "operatingsystem": "AlmaLinux", + "operatingsystemrelease": [ + "8" + ] + }, + { + "operatingsystem": "AmazonLinux", + "operatingsystemrelease": [ + "2", + "2023" + ] + } + ], + "requirements": [ + { + "name": "puppet", + "version_requirement": ">= 8.0.0 < 9.0.0" + } + ], + "description": "Standard Library for Puppet Modules", + "pdk-version": "3.5.0", + "template-url": "https://github.com/puppetlabs/pdk-templates#main", + "template-ref": "heads/main-0-g11c0f3d" +} 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: [] diff --git a/provision.yaml b/provision.yaml new file mode 100644 index 000000000..4df54fcee --- /dev/null +++ b/provision.yaml @@ -0,0 +1,84 @@ +--- +default: + provisioner: docker + images: + - litmusimage/centos:7 +vagrant: + provisioner: vagrant + images: + - centos/7 + - generic/ubuntu1804 + - gusztavvargadr/windows-server +docker_deb: + provisioner: docker + images: + - litmusimage/debian:8 + - litmusimage/debian:9 + - litmusimage/debian:10 +docker_ub_6: + provisioner: docker + images: + - litmusimage/ubuntu:14.04 + - litmusimage/ubuntu:16.04 + - litmusimage/ubuntu:18.04 + - litmusimage/ubuntu:20.04 +docker_el7: + provisioner: docker + images: + - litmusimage/centos:7 + - litmusimage/oraclelinux:7 + - litmusimage/scientificlinux:7 +docker_el8: + provisioner: docker + images: + - litmusimage/centos:8 +release_checks_6: + 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 + - 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 diff --git a/readmes/README_ja_JP.md b/readmes/README_ja_JP.md new file mode 100644 index 000000000..d1d514001 --- /dev/null +++ b/readmes/README_ja_JP.md @@ -0,0 +1,3135 @@ +# stdlib + +#### 目次 + +1. [説明 - モジュールの機能とその有益性](#module-description) +1. [セットアップ - stdlib導入の基本](#setup) +1. [使用方法 - 設定オプションと追加機能](#usage) +1. [参考 - モジュールの機能と動作について](#reference) + 1. [クラス](#classes) + 1. [定義できるタイプ](#defined-types) + 1. [データタイプ](#data-types) + 1. [Facts](#facts) + 1. [関数](#functions) +1. [制約事項 - OSの互換性など](#limitations) +1. [開発 - モジュール貢献についてのガイド](#development) +1. [コントリビュータ](#contributors) + + +## モジュールの概要 + +このモジュールでは、Puppetモジュールリソースの標準ライブラリを提供しています。Puppetモジュールでは、この標準ライブラリを広く使用しています。stdlibモジュールは、以下のリソースをPuppetに追加します。 + + * ステージ + * Facts + * 関数 + * 定義された型 + * データタイプ + * プロバイダ + +> *注:* バージョン3.7のPuppet Enterpriseには、stdlibモジュールが含まれていません。Puppet Enterpriseを使用している場合は、Puppetと互換性のあるstdlibの最新リリースをインストールする必要があります。 + +## セットアップ + +stdlibモジュールを[インストール](https://puppet.com/docs/puppet/latest/modules_installing.html)し、この標準ライブラリの関数、Facts、リソースをPuppetに追加します。 + +stdlibに依存するモジュールを記述する場合は、必ずmetadata.jsonで[依存関係を特定](https://puppet.com/docs/puppet/latest/modules_metadata.html#specifying-dependencies-in-modules)してください。 + +## 使用方法 + +stdlibのほとんどの機能は、Puppetに自動的にロードされます。Puppetで標準化されたランステージを使用するには、`include stdlib`を用いてマニフェスト内でこのクラスを宣言してください。 + +宣言すると、stdlibがモジュール内の他のすべてのクラスを宣言します。現在モジュールに含まれている他のクラスは、`stdlib::stages`のみです。 + +`stdlib::stages`クラスは、インフラストラクチャ、言語ランタイム、アプリケーションレイヤの配備に関する各種のランステージを宣言します。ハイレベルステージは、以下のとおりです(順番どおり)。 + + * セットアップ + * main + * runtime + * setup_infra + * deploy_infra + * setup_app + * deploy_app + * deploy + +使用例: + +```puppet +node default { + include stdlib + class { java: stage => 'runtime' } +} +``` + +## リファレンス + +* [パブリッククラス](#public-classes) +* [プライベートクラス](#private-classes) +* [定義された型](#defined-types) +* [データタイプ](#data-types) +* [Facts](#facts) +* [関数](#functions) + +### クラス + +#### パブリッククラス + +`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'と続く行が探され、その行が行内の値に置き換えられます。 + +マッチ例: + +```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`の例: + +`ensure => absent`を設定する場合に、このタイプの動作には2通りがあります。 + +1つは`match => ...`と`match_for_absence => true`の設定です。`match`により、'export'で始まり'HTTP_PROXY'と続く行が探され、その行が削除されます。複数の行がマッチし、`multiple => true`パラメータが設定されていない場合は、エラーが生じます。 + +この例で`line => ...`パラメータは承認されますが無視されます。 + +例:　 + +```puppet +file_line { 'bashrc_proxy': + ensure => absent, + path => '/etc/bashrc', + match => '^export\ HTTP_PROXY\=', + match_for_absence => true, +} +``` + +`ensure => absent`を設定する場合のもう1つの動作は、`line => ...`の指定と一致なしです。行が存在しないことを確認した場合のデフォルトの動作では、マッチするすべての行を削除します。この動作を無効にすることはできません。 + +例:　 + +```puppet +file_line { 'bashrc_proxy': + ensure => absent, + path => '/etc/bashrc', + line => 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128', +} +``` + + +エンコード例: + +```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`に設定すると、file_lineは1つの行のみ置き換えることができますが、複数の行を置き換えようとするとエラーが発生します。`true`に設定すると、file_lineは1つまたは複数の行を置き換えることができます。 + +値: `true`、`false`。 + +デフォルト値: `false`。 + + +##### `name` + +リソースの名称として使用する名前を指定します。リソースのnamevarをリソースの規定の`title`と異なるものにしたい場合は、`name`で名前を指定します。 + +値: 文字列 + +デフォルト値: タイトルの値 + +##### `path` + +**必須** + +`line`で指定された行を確保するファイルを指定します。 + +値: 当該ファイルの絶対パスを指定する文字列 + +##### `replace` + +`match`パラメータとマッチする既存の行をリソースで上書きするかどうかを指定します。`false`に設定すると、`match`パラメータにマッチする行が見つかった場合、その行はファイルに配置されません。 + +`false`に設定すると、`match`パラメータにマッチする行が見つかった場合、その行はファイルに配置されません。 + +ブーリアン。 + +デフォルト値: `true`。 + +##### `replace_all_matches_not_matching_line` + +`line`がファイルにすでに存在する場合でも、`match`パラメータに一致するすべての行が置き換えられます。 + +デフォルト値: `false`。 + +### データタイプ + +#### `Stdlib::Absolutepath` + +厳密な絶対パスタイプ。UnixpathタイプおよびWindowspathタイプの異形を使用します。 + +使用可能なインプット例: + +```shell +/var/log +``` + +```shell +/usr2/username/bin:/usr/local/bin:/usr/bin:. +``` + +```shell +C:\\WINDOWS\\System32 +``` + +使用不可能なインプット例: + +```shell +../relative_path +``` + +#### `Stdlib::Ensure::Service` + +サービスリソースの使用可能なensure値と一致します。 + +使用可能なインプット例: + +```shell +stopped +running +``` + +使用不可能なインプット例: + +```shell +true +false +``` + +#### `Stdlib::Httpsurl` + +HTTPS URLに一致します。この一致では、大文字と小文字は区別されません。 + +使用可能なインプット例: + +```shell +https://hello.com + +HTTPS://HELLO.COM +``` + +使用不可能なインプット例: + +```shell +httds://notquiteright.org` +``` + +#### `Stdlib::Httpurl` + +HTTPSとHTTPの両方のURLに一致します。この一致では、大文字と小文字は区別されません。 + +使用可能なインプット例: + +```shell +https://hello.com + +http://hello.com + +HTTP://HELLO.COM +``` + +使用不可能なインプット例: + +```shell +httds://notquiteright.org +``` + +#### `Stdlib::MAC` + +[RFC5342](https://tools.ietf.org/html/rfc5342)で定義されるMACアドレスに一致します。 + +#### `Stdlib::Unixpath` + +Unixオペレーティングシステムの絶対パスに一致します。 + +使用可能なインプット例: + +```shell +/usr2/username/bin:/usr/local/bin:/usr/bin: + +/var/tmp +``` + +使用不可能なインプット例: + +```shell +C:/whatever + +some/path + +../some/other/path +``` + +#### `Stdlib::Filemode` + +1から4までの数字とシンボリックファイルモードからなる8進ファイルモードに一致します。 + +使用可能なインプット例: + +```shell +0644 +``` + +```shell +1777 +``` + +```shell +a=Xr,g=w +``` + +使用不可能なインプット例: + +```shell +x=r,a=wx +``` + +```shell +0999 +``` + +#### `Stdlib::Windowspath` + +Windowsオペレーティングシステムのパスに一致します。 + +使用可能なインプット例: + +```shell +C:\\WINDOWS\\System32 + +C:\\ + +\\\\host\\windows +``` + +有効な値: Windowsのファイルパスに一致します。 + +#### `Stdlib::Filesource` + +Puppetファイルタイプのソースパラメータの有効な値のパスに一致します。 + +使用可能なインプット例: + +```shell +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 +``` + +有効な値: 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に規定されたアドレスプレフィックスを持たないアドレスにのみ一致します。 + +### 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 serverのホストネームです。 + +#### `root_home` + +ルートのホームディレクトリを決定します。 + +ルートのホームディレクトリを決定します。これは、オペレーティングシステムによって異なります。通常は'/root'です。 + +#### `service_provider` + +Puppetがこのシステムのサービス管理に使用するデフォルトのプロバイダを返します。 + +### 関数 + +#### `abs` + +**非推奨:** この関数は、Puppet 6.0.0で、内蔵の[`abs`](https://puppet.com/docs/puppet/latest/function.html#abs)関数に置き換えられました。 + +数字の絶対値を返します。たとえば、'-34.56'は'34.56'になります。 + +引数: 整数値または浮動小数点値のいずれかの単一の引数。 + +*タイプ*: 右辺値 + +#### `any2array` + +任意のオブジェクトを、そのオブジェクトを含む配列に変換します。空の引数リストは空の配列に変換されます。ハッシュは、キーと値が交互になった配列に変換されます。配列は変換されません。 + +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` + +任意のオブジェクトをブーリアンに変換します。 + +* 'Y'、'y'、'1'、'T'、't'、'TRUE'、'yes'、'true'といった文字列は`true`を返します。 +* '0'、'F'、'f'、'N'、'n'、'FALSE'、'no'、'false'といった文字列は`false`を返します。 +* ブーリアンは元の値を返します。 +* 0よりも大きい数字(または数字の文字列表現)は`true`を返します。それ以外は`false`を返します。 +* undef値は`false`を返します。 +* それ以外はすべて`true`を返します。 + +詳細については、内蔵の[`Boolean.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-boolean)を参照してください。 + +*タイプ*: 右辺値 + +#### `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 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') +# 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" +``` + +*タイプ*: 右辺値 + +#### `basename` + +パスの`basename`を返します。オプションの引数で拡張子が外れます。例: + +```puppet +basename('/path/to/a/file.ext') => 'file.ext' +basename('relative/path/file.ext') => 'file.ext' +basename('/path/to/a/file.ext', '.ext') => 'file' +``` + +*タイプ*: 右辺値 + +#### `bool2num` + +ブーリアンを数字に変換します。以下の値を変換します。 + +* `false`、'f'、'0'、'n'、'no'を0に変換します。 +* `true`、't'、'1'、'y'、'yes'を1に変換します。 + +引数: インプットとして、単一のブーリアンまたは文字列。 + +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` + +オプションで提供される引数を用いて、ブーリアンを文字列に変換します。オプションの第2および第3の引数は、trueおよびfalseがそれぞれ何に変換されるかを表しています。与えられた引数が1つだけの場合は、ブーリアンから`true`または`false`を含む文字列に変換されます。 + +*例:* + +```puppet +bool2str(true) => `true` +bool2str(true, 'yes', 'no') => 'yes' +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)関数に置き換えられました。 + +文字列または複数文字列の配列の最初の文字を大文字にし、各文字列の残りの文字を小文字にします。 + +引数: インプットとして、単一文字列または配列。*タイプ*: 右辺値 + +*注:* この関数はRubyクラスの実装にあたり、UTF8との互換性がない可能性があります。互換性を確保するには、Ruby 2.4.0以降でこの関数を使用してください。 + +#### `ceiling` + +**非推奨:**この関数は、Puppet 6.0.0で、内蔵の[`ceiling`](https://puppet.com/docs/puppet/latest/function.html#ceiling)関数に置き換えられました。 + +引数以上の最小整数を返します。 + +引数: 単一の数値。 + +*タイプ*: 右辺値 + +#### `chomp` + +**非推奨:**この関数は、Puppet 6.0.0で、内蔵の[`chomp`](https://puppet.com/docs/puppet/latest/function.html#chomp)関数に置き換えられました。 + +文字列または複数文字列の配列の最後から、レコード分離文字を削除します。たとえば、'hello\n'は'hello'になります。 + +引数: 単一の文字または配列。 + +*タイプ*: 右辺値 + +#### `chop` + +**非推奨:**この関数は、Puppet 6.0.0で、内蔵の[`chop`](https://puppet.com/docs/puppet/latest/function.html#chop)関数に置き換えられました。 + +最後の文字を削除した新しい文字列を返します。文字列が'\r\n'で終わる場合は、両方の文字が削除されます。`chop`を空文字列に適用すると、空文字列が返されます。レコード分離文字のみを削除する場合は、`chomp`関数を使用してください。 + +引数: インプットとして、文字列または複数文字列の配列。 + +*タイプ*: 右辺値 + +#### `clamp` + +整数値に基づく分類により、当該領域[Min、X、Max]内で値を維持します(パラメータの順序は関係ありません)。文字列が変換され、数字として比較されます。値の配列は、さらなる処理が可能なリストに平坦化されます。例: + + * `clamp('24', [575, 187])`は187を返します。 + * `clamp(16, 88, 661)`は88を返します。 + * `clamp([4, 3, '99'])`は4を返します。 + +引数: 文字列、配列、数字。 + +Puppet 6.0.0以降では、内蔵の関数を使用して同じ結果を得ることができます。 + + [$minval, $maxval, $value_to_clamp].sort[1] + +*タイプ*: 右辺値 + +#### `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']を返します。 + +Puppet 4.0以降では、配列の連結とハッシュのマージのために`+`演算子を使い、`<<`演算子を使って追加することができます。 + + ['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]] + +*タイプ*: 右辺値 + +#### `convert_base` + +与えられた整数または整数を表す10進数文字列を、指定した基数の文字列に変換します。例: + + * `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` + +配列を最初の引数とオプションの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を通知します。 + +*タイプ*: 右辺値 + +#### `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']を返します。 + +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` + +決められたインデックス付き値を配列から削除します。 + +例: `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` + +提示された正規表現にマッチする任意の要素のインスタンスを、配列またはハッシュからすべて削除します。文字列は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']を返します。 + +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` + +任意の値のインスタンスをハッシュからすべて削除します。 + +例:　 + +* `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` + +`undef`値のインスタンスをアレイまたはハッシュからすべて削除します。 + +例:　 + +* `$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` + +非推奨警告をプリントし、任意のキーについて警告を一度記録します: + +```puppet +deprecation(key, message) +``` + +引数: + +* キーを指定する文字列: Puppetプロセスの継続期間中にメッセージの数を少なく抑えるために、1つのキーにつき1つのメッセージのみを記録します。 +* メッセージを指定する文字列: 記録されるテキスト。 + +*タイプ*: ステートメント + +**`deprecation`に影響を与える設定** + +Puppetの他の設定は、stdlibの`deprecation`関数に影響を与えます。 + +* [`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`: メッセージがアウトプットされません。 + * `warning`: すべての警告を記録します。これがデフォルト設定です。 + +* 環境変数`STDLIB_LOG_DEPRECATIONS` + + 非推奨警告を記録するかどうかを指定します。これは特に、自動テストの際、移行の準備ができる前にログに情報が氾濫するのを避けるうえで役立ちます。 + + この変数はブーリアンで、以下の効果があります: + + * `true`: 警告を記録します。 + * `false`: 警告は記録されません。 + * 値を設定しない場合: Puppet 4は警告を出しますが、Puppet 3は出しません。 + +#### `difference` + +2つの配列の間の差異を返します。返される配列はオリジナル配列のコピーで、第2の配列にも見られるアイテムがあれば、それが取り除かれます。 + +例:　 + +* `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://puppet.com/docs/puppet/latest/function.html#dig)関数に置き換えられました。下位互換性を得るには、[`dig44()`](#dig44)を使用するか、新しいバージョンを使用してください。 + +パスを含むキー配列を通じて、複数レイヤーのハッシュおよびアレイ内の値を探します。この関数は各パスコンポーネントにより構造内を移動し、パスの最後で値を返すよう試みます。 + +この関数では、必要とされるパス引数に加え、デフォルトの引数を使用できます。パスが正しくない場合や、値が見つからない場合、その他のエラーが生じた場合は、デフォルトの引数を返します。 + +```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** 取り扱うデータ構造。 +2. **['a', 'b', 2]** パス配列。 +3. **'not_found'** デフォルト値。何も見つからない場合に返されます。 + +デフォルト値: `undef`。 + +*タイプ*: 右辺値 + +#### `dig44` + +パスを含むキー配列を通じて、複数レイヤーのハッシュおよびアレイ内の値を探します。この関数は各パスコンポーネントにより構造内を移動し、パスの最後で値を返すよう試みます。 + +この関数では、必要とされるパス引数に加え、デフォルトの引数を使用できます。パスが正しくない場合や、値が見つからない場合、その他のエラーが生じた場合は、デフォルトの引数を返します。 + +```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** 取り扱うデータ構造。 +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` + +**非推奨:**この関数は、Puppet 5.5.0で、内蔵の[`downcase`](https://puppet.com/docs/puppet/latest/function.html#downcase)関数に置き換えられました。 + +配列内の1つの文字列またはすべての文字列の大文字と小文字の別を、小文字に変換します。 + +*注:* この関数はRubyクラスの実装にあたり、UTF8との互換性がない可能性があります。互換性を確保するには、Ruby 2.4.0以降でこの関数を使用してください。 + +*タイプ*: 右辺値 + +#### `empty` + +**非推奨:**この関数は、Puppet 5.5.0で、内蔵の[`empty`](https://puppet.com/docs/puppet/latest/function.html#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'}) +``` + +#### `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` + +**非推奨:**この関数は、Puppet 5.5.0で、内蔵の[`flatten`](https://puppet.com/docs/puppet/latest/function.html#flatten)関数に置き換えられました。 + +ネストの深いアレイを平坦化し、結果として単一のフラット配列を返します。 + +たとえば、`flatten(['a', ['b', ['c']]])`は['a','b','c']を返します。 + +*タイプ*: 右辺値 + +#### `floor` + +**非推奨:**この関数は、Puppet 5.5.0で、内蔵の[`floor`](https://puppet.com/docs/puppet/latest/function.html#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') +``` + +Puppet 5.4.0以降では、内蔵の [`module_directory`](https://puppet.com/docs/puppet/latest/function.html#module_directory)関数は同じことを行い、複数の値または配列が与えられている場合、最初に見つかったモジュールへのパスを返します。 + +*タイプ*: 右辺値 + +#### `getparam` +リソースのパラメータの値を返します。 + +引数: リソースリファレンスおよびパラメータの名前。 + +> 注意: ユーザ定義のリソースタイプは遅れて評価されます。 + +*例:* + +```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': } +``` + +'この例で取得している値'を通知します + +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) +関数に置き換えられました。新しいバージョンでも、構造化された値への掘り下げがサポートされます。 + +リモートネームスペースの変数を調べます。 + +例:　 + +```puppet +$foo = getvar('site::data::foo') +# $foo = $site::data::fooと同等 +``` + +この関数は、ネームスペースそのものが文字列に保存されている場合に役立ちます: + +```puppet +$datalocation = 'site::data' +$bar = getvar("${datalocation}::bar") +# Equivalent to $bar = $site::data::bar +``` + +*タイプ*: 右辺値 + +#### `glob` + +パスパターンに一致するパスの文字列配列を返します。 + +引数: パスパターンを指定する文字列または文字列配列。 + +```puppet +$confs = glob(['/etc/**/*.conf', '/opt/**/*.conf']) +``` + +*タイプ*: 右辺値 + +#### `grep` + +配列内を検索し、提示された正規表現に一致する要素を返します。 + +たとえば、`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` + +種類および値に基づきブーリアンを返します: + + * 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` +**非推奨:** この関数は、内蔵の`in`演算子に置き換えられました。 + +ハッシュに特定のキー値があるかどうかを判定します。 + +*例*: + +``` +$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') +} +``` + +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}を返します。 + +*タイプ*: 右辺値 + +#### `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://puppet.com/docs/puppet/latest/lang_data.html)を参照してください。 +* 値のタイプを特定する各種の方法については、[`assert_type()`](https://puppet.com/docs/puppet/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_email_address` + +この関数に渡された文字列が有効なメールアドレスである場合に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` + +**非推奨:** この関数は、Puppet 5.5.0で、内蔵の[`join`](https://puppet.com/docs/puppet/latest/function.html#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"]になります。 + +Puppet 5.0.0以降では、書式の制御が強化されています（インデントや改行、配列とハッシュエントリ、ハッシュエントリのキー/値の間の区切り、配列における値の個々の +書式など)。内蔵の[`String.new`](https://docs.puppet.com/puppet/latest/function.html#conversion-to-string)関数、および`配列`と`ハッシュ`の書式設定オプションを参照してください。 + +*タイプ*: 右辺値 + +#### `keys` + +**非推奨:** この関数は、Puppet 5.5.0で、内蔵の[`keys`](https://puppet.com/docs/puppet/latest/function.html#keys)関数に置き換えられました。 + +ハッシュのキーを配列として返します。 + +*タイプ*: 右辺値 + +#### `length` + +**非推奨:** この関数は、Puppet 5.5.0で、内蔵の[`length`](https://puppet.com/docs/puppet/latest/function.html#length)関数に置き換えられました。 + +与えられた文字列、配列、ハッシュの長さを返します。廃止された`size()`関数に代わるものです。 + +*タイプ*: 右辺値 + +#### `loadyaml` + +配列、文字列、ハッシュを含むYAMLファイルをロードし、対応するネイティブデータタイプでデータを返します。 + +例:　 + +```puppet +$myhash = loadyaml('/etc/puppet/data/myhash.yaml') +``` + +第2のパラメータは、ファイルが見つからなかった場合、または構文解析できなかった場合に返されます。 + +例:　 + +```puppet +$myhash = loadyaml('no-file.yaml', {'default'=>'value'}) +``` + +*タイプ*: 右辺値 + +#### `loadjson` + +配列、文字列、ハッシュを含むJSONファイルをロードし、対応するネイティブデータタイプでデータを返します。 + +例:　 + +最初のパラメータは、絶対ファイルパスまたはURLです。 + +```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 { "このモジュールにはmetadata.jsonファイルがありません。": } +} +``` + +*タイプ*: 右辺値 + +#### `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つの引数が必要です。 + +引数: 数字または数字を表す文字列。 + +*タイプ*: 右辺値 + +#### `member` + +変数が配列の構成要素かどうかを判定します。変数には文字列、配列、fixnumが使用できます。 + +たとえば、`member(['a','b'], 'b')`および`member(['a','b','c'], ['b','c'])`は`true`を返し、`member(['a','b'], 'c')`および`member(['a','b','c'], ['c','d'])`は`false`を返します。 + +*注*: この関数は、ネスト化した配列には対応していません。最初の引数にネスト化した配列が含まれている場合は、再帰的処理は行われません。 + +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` + +2つ以上のハッシュを統合し、その結果得られたハッシュを返します。 + +*例*: + +```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'} +``` + +重複キーが存在する場合は、最右のハッシュのキーが上位になります。 + +Puppet 4.0.0以降では、+ 演算子を使用して同じマージを実行することができます。 + + $merged_hash = $hash1 + $hash2 + +*タイプ*: 右辺値 + +#### `min` + +**非推奨:** この関数は、Puppet 6.0.0で、内蔵の[`min`](https://puppet.com/docs/puppet/latest/function.html#min)関数に置き換えられました。 + +すべての引数の最小値を返します。少なくとも1つの引数が必要です。 + +引数: 数字または数字を表す文字列。 + +*タイプ*: 右辺値 + +#### `num2bool` + +数字または数字の文字列表現を正当なブーリアンに変換します。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` + +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'}を返します。 + +Puppet 4.0.0以降では、内蔵の[`map`](https://docs.puppet.com/puppet/latest/function.html#map)関数を使用して配列の値を変更します。 +この例は、上記の最初の例と同じです。 + + ['a', 'b', 'c'].map |$x| { "p${x}" } + +*タイプ*: 右辺値 + +#### `pry` + +現在のスコープオブジェクトでpryデバッグセッションを起動します。コンパイル中の特定ポイントにおけるマニフェストコードのデバッグに役立ちます。`puppet apply`の実行中またはフォアグラウンドでPuppet serverを実行しているときにのみ使用する必要があります。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 serverの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"]を返します。 + +> 注意: Puppet言語では、タイプシステムを使用して、`整数`と`フロート`の範囲をサポートしています。これらは、指定された回数の反復に適しています。 + +値のスキップについては、Puppetに内蔵の[`step`](https://docs.puppet.com/puppet/latest/function.html#step)関数を参照してください。 + + 整数[0, 9]。それぞれの|$x| { notice($x) } #は、0, 1, 2, ... 9を通知します。 + +*タイプ*: 右辺値 + +#### `regexpescape` + +文字列または文字列の配列を正規表現エスケープします。インプットとして、単一の文字列または配列のいずれかが必要です。 + +*タイプ*: 右辺値 + +#### `reject` + +配列を検索し、提示された正規表現に一致する要素をすべてリジェクトします。 + +たとえば、`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`)関数に置き換えられました。 + +文字列の右側のスペースを取り除きます。 + +*タイプ*: 右辺値 + +#### `seeded_rand` + +整数の最大値と文字列のシード値を取り、最大値よりも小さい反復可能かつランダムな整数を返します。`fqdn_rand`と同様ですが、シードにノード固有のデータが追加されません。 + +*タイプ*: 右辺値 + +#### `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)を参照してください。 + +例:　 + +```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 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)機能のマニュアルを参照してください。 + +例:　 + +```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` + +**非推奨:**この関数は、Puppet 5.5.0で、内蔵の[`sort`](https://puppet.com/docs/puppet/latest/function.html#sort)関数に置き換えられました。 + +文字列と配列を語彙的に分類します。 + +*タイプ*: 右辺値 + +>*注:* この関数はRubyクラスの実装にあたり、UTF8との互換性がない可能性があります。互換性を確保するには、Ruby 2.4.0以降でこの関数を使用してください。 + +#### `squeeze` + +文字列内の連続した繰り返し('aaaa'など)を単一文字に置き換え、新たな文字列を返します。 + +*タイプ*: 右辺値 + +#### `str2bool` + +特定の文字列をブーリアンに変換します。値'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` + +OS Xバージョン10.7以上で使用されるソルト付きSHA512パスワードハッシュに文字列を変換します。hexバージョンのソルト付きSHA512パスワードハッシュを返します。これは、有効なパスワード属性としてPuppetマニフェストに挿入することができます。 + +*タイプ*: 右辺値 + +>*注:* この関数は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")`は日付を返します。 + +引数: `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` + +**非推奨:**この関数は、Puppet 5.5.0で、内蔵の[`strip`](https://puppet.com/docs/puppet/latest/function.html#`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'}を返します。 + +Puppet 4.0.0以降では、内蔵の[`map`](https://docs.puppet.com/puppet/latest/function.html#map)関数を使用して配列の値を変更します。この例は、上記の最初の例と同じです。 + + ['a', 'b', 'c'].map |$x| { "${x}p" } + +*タイプ*: 右辺値 + +#### `swapcase` + +文字列の現在の大文字と小文字を入れ替えます。たとえば、`swapcase("aBcD")`は"AbCd"になります。 + +*タイプ*: 右辺値 + +>*注:* この関数はRubyクラスの実装にあたり、UTF8との互換性がない可能性があります。互換性を確保するには、Ruby 2.4.0以降でこの関数を使用してください。 + +#### `time` + +現在のUnixエポック時刻を整数として返します。 + +たとえば、`time()`は'1311972653'などを返します。 + +Puppet 4.8.0以降、Puppet言語には、``Timestamp` (時点)と`Timespan` (期間)の各データタイプがあります。次の例は、引数なしで`time()`を呼び出すのと同じです。 + +タイムスタンプ() + +*タイプ*: 右辺値 + +#### `to_bytes` + +引数をバイトに変換します。 + +たとえば、"4 kB"は"4096"になります。 + +引数: 単一の文字列。 + +*タイプ*: 右辺値 + +#### `to_json` + +入力値をJSON形式の文字列に変換します。 + +例えば、`{ "key" => "value" }`は`{"key":"value"}`になります。 + +*タイプ*: 右辺値 + +#### `to_json_pretty` + +入力値を整形されたJSON形式の文字列に変換します。 + +例えば、`{ "key" => "value" }`は`{\n \"key\": \"value\"\n}`になります。 + +*タイプ*: 右辺値 + +#### `to_yaml` + +入力値をYAML形式の文字列に変換します。 + +例えば、`{ "key" => "value" }`は`"---\nkey: value\n"`になります。 + +*タイプ*: 右辺値 + +#### `try_get_value` + +**非推奨:** `dig()`に置き換えられました。 + +ハッシュおよび配列の複数レイヤー内の値を取得します。 + +引数: + +* 第1の引数として、パスを含む文字列。この引数は、ゼロではじまり、パス区切り文字(デフォルトは"/")で区切ったハッシュキーまたは配列インデックスの文字列として提示してください。この関数は各パスコンポーネントにより構造内を移動し、パスの最後で値を返すよう試みます。 + +* デフォルトの第2の引数。パスが正しくない場合や、値が見つからない場合、その他のエラーが生じた場合は、この引数が返されます。 +* 最後の引数として、パス区切り文字。 + +```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** 取り扱うデータ構造。 +2. **'a/b/2'** パス文字列。 +3. **'not_found'** デフォルト値。何も見つからない場合に返されます。 + (オプション、デフォルトは`undef`) +4. **'/'** パス区切り文字。 + (オプション、デフォルトは*'/'*) + +*タイプ*: 右辺値 + +#### `type3x` + +**非推奨:**この関数は、今後のリリースで廃止されます。 + +与えられた値のタイプを説明する文字列を返します。タイプとしては、文字列、配列、ハッシュ、フロート、整数、ブーリアンが可能です。Puppet 4では、この代わりに新しいタイプシステムを使用してください。 + +引数: + +* 文字列 +* 配列 +* ハッシュ +* フロート +* 整数 +* ブーリアン + +*タイプ*: 右辺値 + +#### `type_of` + +この関数は下位互換性を得るために提供されていますが、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] { ... }`に相当します)、`<=`を用いたタイプの比較に役立ちます。 + +*タイプ*: 右辺値 + +#### `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` + +**非推奨:**この関数は、Puppet 5.5.0で、内蔵の[`upcase`](https://puppet.com/docs/puppet/latest/function.html#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 +# 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') +``` + +*タイプ*: ステートメント + +#### `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)を参照してください。 + +渡されたすべての値がハッシュデータ構造であることを確認します。このチェックで不合格となった値がある場合は、カタログコンパイルが中止されます。 + +以下の値が渡されます: + +```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://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: 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://puppet.com/docs/puppet/latest/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 +クラスの例( + 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` + +**非推奨:**この関数は、Puppet 5.5.0で、内蔵の[`values`](https://puppet.com/docs/puppet/latest/function.html#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']を返します。 + +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` + +与えられた第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の最新リリースをインストールする必要があります。 + +サポートされているオペレーティングシステムの一覧については、[metadata.json](https://github.com/puppetlabs/puppetlabs-stdlib/blob/main/metadata.json)を参照してください。 + +### バージョン互換性 + +バージョン | Puppet 2.6 | Puppet 2.7 | Puppet 3.x | Puppet 4.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)を参照してください。 + +このモジュールの一部に関するバグの報告または調査は、 +[https://github.com/puppetlabs/puppetlabs-stdlib/issues](https://github.com/puppetlabs/puppetlabs-stdlib/issues)からお願いします。 + +## コントリビュータ + +コントリビュータのリストは、[https://github.com/puppetlabs/puppetlabs-stdlib/graphs/contributors](https://github.com/puppetlabs/puppetlabs-stdlib/graphs/contributors)で見ることができます。 diff --git a/spec/acceptance/anchor_spec.rb b/spec/acceptance/anchor_spec.rb new file mode 100644 index 000000000..9136b6623 --- /dev/null +++ b/spec/acceptance/anchor_spec.rb @@ -0,0 +1,28 @@ +# frozen_string_literal: true + +require 'spec_helper_acceptance' + +describe 'anchor type' do + let(:pp) do + <<-MANIFEST + class anchored { + anchor { 'anchored::begin': } + ~> anchor { 'anchored::end': } + } + + class anchorrefresh { + notify { 'first': } + ~> class { 'anchored': } + ~> anchor { 'final': } + } + + include anchorrefresh + 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/file_line_spec.rb b/spec/acceptance/file_line_spec.rb new file mode 100644 index 000000000..6971c2eff --- /dev/null +++ b/spec/acceptance/file_line_spec.rb @@ -0,0 +1,154 @@ +# frozen_string_literal: true + +require 'spec_helper_acceptance' + +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}': + ensure => present, + content => 'a wild test file has appeared!', + } + file { '#{test_file}.does_not_exist': + ensure => absent, + } + 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 + + 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 diff --git a/spec/classes/anchor_spec.rb b/spec/classes/anchor_spec.rb deleted file mode 100644 index 2dd17de9a..000000000 --- a/spec/classes/anchor_spec.rb +++ /dev/null @@ -1,32 +0,0 @@ -require 'puppet' -require 'rspec-puppet' - -describe "anchorrefresh" do - let(:node) { 'testhost.example.com' } - let :pre_condition do - <<-ANCHORCLASS -class anchored { - anchor { 'anchored::begin': } - ~> anchor { 'anchored::end': } -} - -class anchorrefresh { - notify { 'first': } - ~> class { 'anchored': } - ~> anchor { 'final': } -} - ANCHORCLASS - end - - def apply_catalog_and_return_exec_rsrc - catalog = subject.to_ral - transaction = catalog.apply - transaction.resource_status("Anchor[final]") - end - - it 'propagates events through the anchored class' do - resource = apply_catalog_and_return_exec_rsrc - - expect(resource.restarted).to eq(true) - end -end diff --git a/spec/classes/manage_spec.rb b/spec/classes/manage_spec.rb new file mode 100644 index 000000000..ce78ec2f0 --- /dev/null +++ b/spec/classes/manage_spec.rb @@ -0,0 +1,63 @@ +# 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]' + }, + '/etc/motd' => { + 'epp' => { + 'template' => 'profile/motd.epp' + } + }, + '/etc/information' => { + 'erb' => { + 'template' => 'profile/information.erb' + } + } + }, + 'package' => { + 'example' => { + 'ensure' => 'installed', + 'subscribe' => ['Service[sshd]', 'File[/etc/motd.d]'] + } + } + } + } + end + + Puppet::Functions.create_function(:epp) do + 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 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 diff --git a/spec/default_facts.yml b/spec/default_facts.yml new file mode 100644 index 000000000..3346c394d --- /dev/null +++ b/spec/default_facts.yml @@ -0,0 +1,9 @@ +# Use default_module_facts.yml for module specific facts. +# +# 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" +is_pe: false 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/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/fixtures/test/manifests/base32.pp b/spec/fixtures/test/manifests/base32.pp new file mode 100644 index 000000000..3c01b73bc --- /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..1870c8225 --- /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/fixtures/test/manifests/deftype.pp b/spec/fixtures/test/manifests/deftype.pp new file mode 100644 index 000000000..dd58aab86 --- /dev/null +++ b/spec/fixtures/test/manifests/deftype.pp @@ -0,0 +1,4 @@ +# Class to test deftype +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 new file mode 100644 index 000000000..60e7a40d5 --- /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/functions/any2array_spec.rb b/spec/functions/any2array_spec.rb new file mode 100644 index 000000000..679ba9ea0 --- /dev/null +++ b/spec/functions/any2array_spec.rb @@ -0,0 +1,23 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'any2array' do + 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]) } + 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('‰').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/any2bool_spec.rb b/spec/functions/any2bool_spec.rb new file mode 100644 index 000000000..03fb21906 --- /dev/null +++ b/spec/functions/any2bool_spec.rb @@ -0,0 +1,43 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'any2bool' 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(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 diff --git a/spec/functions/assert_private_spec.rb b/spec/functions/assert_private_spec.rb new file mode 100644 index 000000000..8edfe4158 --- /dev/null +++ b/spec/functions/assert_private_spec.rb @@ -0,0 +1,40 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'assert_private' do + 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).to run.with_params + 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).to run.with_params.and_raise_error(Puppet::ParseError, %r{Class foo::baz is private}) + end + + it 'fails with an explicit failure message' do + expect(subject).to run.with_params('failure message!').and_raise_error(Puppet::ParseError, %r{failure message!}) + 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).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 new file mode 100644 index 000000000..111910faf --- /dev/null +++ b/spec/functions/base64_spec.rb @@ -0,0 +1,70 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'base64' do + 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}) } + 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 { + 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 { + 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 { + 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 { + 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 { + 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 { + expect(subject).to run.with_params('encode', 'https://www.google.com.tw/?gws_rd=ssl#q=hello+world', 'urlsafe') + .and_return('aHR0cHM6Ly93d3cuZ29vZ2xlLmNvbS50dy8_Z3dzX3JkPXNzbCNxPWhlbGxvK3dvcmxk') + } + + it { + expect(subject).to run.with_params('decode', 'aHR0cHM6Ly93d3cuZ29vZ2xlLmNvbS50dy8_Z3dzX3JkPXNzbCNxPWhlbGxvK3dvcmxk', 'urlsafe') + .and_return('https://www.google.com.tw/?gws_rd=ssl#q=hello+world') + } + + it { + 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 { + 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/basename_spec.rb b/spec/functions/basename_spec.rb new file mode 100644 index 000000000..e9934ca13 --- /dev/null +++ b/spec/functions/basename_spec.rb @@ -0,0 +1,21 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'basename' do + 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}) } + 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') } + 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 '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/batch_escape_spec.rb b/spec/functions/batch_escape_spec.rb new file mode 100644 index 000000000..623dc92be --- /dev/null +++ b/spec/functions/batch_escape_spec.rb @@ -0,0 +1,27 @@ +# frozen_string_literal: true + +require 'spec_helper' + +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{'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 + 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 { + expect(subject).to run.with_params('~`!@#$%^&*()_-=[]\{}|;\':",./<>?') + .and_return('"~`!@#\\$%^&*()_-=[]\\\{}|;\':"",./<>?"') + } + end +end diff --git a/spec/functions/bool2num_spec.rb b/spec/functions/bool2num_spec.rb new file mode 100644 index 000000000..55e277c0c --- /dev/null +++ b/spec/functions/bool2num_spec.rb @@ -0,0 +1,20 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'bool2num' do + 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| + it { is_expected.to run.with_params(truthy).and_return(1) } + end + + [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/bool2str_spec.rb b/spec/functions/bool2str_spec.rb new file mode 100644 index 000000000..0e955b964 --- /dev/null +++ b/spec/functions/bool2str_spec.rb @@ -0,0 +1,19 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'bool2str' do + 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| + 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 diff --git a/spec/functions/clamp_spec.rb b/spec/functions/clamp_spec.rb new file mode 100644 index 000000000..43c877b7c --- /dev/null +++ b/spec/functions/clamp_spec.rb @@ -0,0 +1,19 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'clamp' do + 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}) } + 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) } + 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 diff --git a/spec/functions/concat_spec.rb b/spec/functions/concat_spec.rb new file mode 100644 index 000000000..504259444 --- /dev/null +++ b/spec/functions/concat_spec.rb @@ -0,0 +1,30 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'concat' 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}) } + 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']) } + 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(['ấ', 'β', '©'], ['đ', 'ể', '文字列']).and_return(['ấ', 'β', '©', 'đ', 'ể', '文字列']) } + end + + arguments = [['1', '2', '3'], ['4', '5', '6']] + originals = [arguments[0].dup, arguments[1].dup] + it 'leaves the original array intact' do + _result = subject.execute(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 new file mode 100644 index 000000000..3ea7d44e2 --- /dev/null +++ b/spec/functions/convert_base_spec.rb @@ -0,0 +1,26 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'convert_base' 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('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 'raises a ParseError if argument 1 is a string that does not correspond to an integer in base 10' do + 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 + 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') } + 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 new file mode 100644 index 000000000..2ce409633 --- /dev/null +++ b/spec/functions/count_spec.rb @@ -0,0 +1,27 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'count' 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('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') + 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) } + 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(['ổņ℮', 'ŧщộ', '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/crc32_spec.rb b/spec/functions/crc32_spec.rb new file mode 100644 index 000000000..5519b6841 --- /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 be_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 diff --git a/spec/functions/deep_merge_spec.rb b/spec/functions/deep_merge_spec.rb new file mode 100644 index 000000000..07291f8a1 --- /dev/null +++ b/spec/functions/deep_merge_spec.rb @@ -0,0 +1,63 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'deep_merge' 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('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') } + + describe 'when arguments have key collisions' do + it 'prefers values from the last hash' do + 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 { + expect(subject).to run \ + .with_params({ 'key1' => 'value1' }, { 'key1' => 'value2' }, 'key1' => 'value3') \ + .and_return('key1' => 'value3') + } + end + + describe 'when arguments have subhashes' do + it { + expect(subject).to run \ + .with_params({ 'key1' => 'value1' }, 'key2' => 'value2', 'key3' => { 'subkey1' => 'value4' }) \ + .and_return('key1' => 'value1', 'key2' => 'value2', 'key3' => { 'subkey1' => 'value4' }) + } + + it { + expect(subject).to run \ + .with_params({ 'key1' => { 'subkey1' => 'value1' } }, 'key1' => { 'subkey2' => 'value2' }) \ + .and_return('key1' => { 'subkey1' => 'value1', 'subkey2' => 'value2' }) + } + + it { + expect(subject).to run \ + .with_params({ 'key1' => { 'subkey1' => { 'subsubkey1' => 'value1' } } }, 'key1' => { 'subkey1' => { 'subsubkey1' => 'value2' } }) \ + .and_return('key1' => { 'subkey1' => { 'subsubkey1' => 'value2' } }) + } + end + + arguments = { 'key1' => 'value1' }, { 'key2' => 'value2' } + originals = [arguments[0].dup, arguments[1].dup] + it 'does not change the original hashes' do + subject.execute(arguments[0], arguments[1]) + arguments.each_with_index do |argument, index| + expect(argument).to eq(originals[index]) + end + end + + 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 28dbab311..6997ba9b9 100644 --- a/spec/functions/defined_with_params_spec.rb +++ b/spec/functions/defined_with_params_spec.rb @@ -1,19 +1,24 @@ -#! /usr/bin/env ruby -S rspec +# frozen_string_literal: true + require 'spec_helper' -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) } + 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 - 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) + + 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 '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 @@ -21,17 +26,109 @@ let :pre_condition do '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'} - ).and_return(true) - should run.with_params('User[dan]', - {'ensure' => 'present', 'managehome' => false} - ).and_return(true) - should run.with_params('User[dan]', - {'ensure' => 'absent', 'managehome' => false} - ).and_return(false) + + 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 + + describe 'when passing undef values' do + 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_value).and_return(true) } + end + + describe 'when the reference is a' do + let :pre_condition do + 'user { "dan": }' + end + + 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 + expect { + subject.execute(['User[dan]'], {}) + }.to raise_error(ArgumentError, %r{not understood: 'Array'}) + end + end + end + end + + describe 'when passed a defined type' do + let :pre_condition do + <<-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 { + 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 + } + 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": }' + 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 diff --git a/spec/functions/delete_at_spec.rb b/spec/functions/delete_at_spec.rb new file mode 100644 index 000000000..dc0a7578e --- /dev/null +++ b/spec/functions/delete_at_spec.rb @@ -0,0 +1,32 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'delete_at' 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}) } + 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.') + expect(subject).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, %r{Given index exceeds size of array}) } + 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 { is_expected.to run.with_params(['ƒờở', 'βāř', 'ьầż'], 1).and_return(['ƒờở', 'ьầż']) } + + it 'leaves the original array intact' do + argument = [1, 2, 3] + original = argument.dup + _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 new file mode 100644 index 000000000..6f4d7048f --- /dev/null +++ b/spec/functions/delete_regex_spec.rb @@ -0,0 +1,60 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'delete_regex' 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}) } + 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, %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([]) } + 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 { + expect(subject).to run \ + .with_params({ 'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3' }, 'key2') \ + .and_return('key1' => 'value1', 'key3' => 'value3') + } + + it { + expect(subject).to run \ + .with_params({ 'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3' }, ['key1', 'key2']) \ + .and_return('key3' => 'value3') + } + end + + it 'leaves the original array intact' do + argument1 = ['one', 'two', 'three'] + original1 = argument1.dup + 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.execute(argument1, 'key2') + expect(argument1).to eq(original1) + end +end diff --git a/spec/functions/delete_spec.rb b/spec/functions/delete_spec.rb new file mode 100644 index 000000000..37fee322b --- /dev/null +++ b/spec/functions/delete_spec.rb @@ -0,0 +1,86 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'delete' 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}) } + 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, %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([]) } + 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(['ŧңŗё℮']) } + end + + 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') } + 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 + + 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 { + expect(subject).to run \ + .with_params({ 'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3' }, 'key2') \ + .and_return('key1' => 'value1', 'key3' => 'value3') + } + + it { + expect(subject).to run \ + .with_params({ 'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3' }, ['key1', 'key2']) \ + .and_return('key3' => 'value3') + } + + it { + expect(subject).to run \ + .with_params({ 'ĸəұ1' => 'νãŀủĕ1', 'ĸəұ2' => 'νãŀủĕ2', 'ĸəұ3' => 'νãŀủĕ3' }, ['ĸəұ1', 'ĸəұ2']) \ + .and_return('ĸəұ3' => 'νãŀủĕ3') + } + end + + it 'leaves the original array intact' do + argument1 = ['one', 'two', 'three'] + original1 = argument1.dup + _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 + _result = subject.execute(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 new file mode 100644 index 000000000..4a251cdc2 --- /dev/null +++ b/spec/functions/delete_undef_values_spec.rb @@ -0,0 +1,66 @@ +# frozen_string_literal: true + +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 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}) } + 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 + [: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']) } + it { is_expected.to run.with_params(['ớņέ', undef_value, 'ŧשּׁō', 'ŧħґëə']).and_return(['ớņέ', 'ŧשּׁō', 'ŧħґëə']) } + end + + it 'leaves the original argument intact' do + argument = ['one', undef_value, 'two'] + original = argument.dup + _result = subject.execute(argument, 2) + expect(argument).to eq(original) + end + end + + it { is_expected.to run.with_params(['undef']).and_return(['undef']) } + end + + describe 'when deleting from a hash' 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('key' => undef_value).and_return({}) } + + it { + expect(subject).to run \ + .with_params('key1' => 'value1', 'undef_key' => undef_value, 'key2' => 'value2') \ + .and_return('key1' => 'value1', 'key2' => 'value2') + } + end + + it 'leaves the original argument intact' do + argument = { 'key1' => 'value1', 'key2' => undef_value } + original = argument.dup + _result = subject.execute(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 new file mode 100644 index 000000000..df1752ec5 --- /dev/null +++ b/spec/functions/delete_values_spec.rb @@ -0,0 +1,52 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'delete_values' 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}) } + 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}) } + 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 + it { is_expected.to run.with_params({}, 'value').and_return({}) } + + it { + expect(subject).to run \ + .with_params({ 'key1' => 'value1' }, 'non-existing value') \ + .and_return('key1' => 'value1') + } + + it { + expect(subject).to run \ + .with_params({ 'ҝếỵ1 ' => 'νâĺūẹ1', 'ҝếỵ2' => 'value to delete' }, 'value to delete') \ + .and_return('ҝếỵ1 ' => 'νâĺūẹ1') + } + + it { + expect(subject).to run \ + .with_params({ 'key1' => 'value1', 'key2' => 'νǎŀữ℮ ťớ đêłểťė' }, 'νǎŀữ℮ ťớ đêłểťė') \ + .and_return('key1' => 'value1') + } + + it { + expect(subject).to run \ + .with_params({ 'key1' => 'value1', 'key2' => 'value to delete', 'key3' => 'value to delete' }, 'value to delete') \ + .and_return('key1' => 'value1') + } + end + + it 'leaves the original argument intact' do + argument = { 'key1' => 'value1', 'key2' => 'value2' } + original = argument.dup + _result = subject.execute(argument, 'value2') + expect(argument).to eq(original) + end +end diff --git a/spec/functions/deprecation_spec.rb b/spec/functions/deprecation_spec.rb new file mode 100644 index 000000000..e0b66a7bb --- /dev/null +++ b/spec/functions/deprecation_spec.rb @@ -0,0 +1,76 @@ +# frozen_string_literal: true + +require 'spec_helper' + +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 + + 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') + 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 + 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 + + 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 + + context 'with `use_strict_setting` `false`' do + let(:params) { ['key', 'heelo', false] } + + 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 diff --git a/spec/functions/difference_spec.rb b/spec/functions/difference_spec.rb new file mode 100644 index 000000000..a66317567 --- /dev/null +++ b/spec/functions/difference_spec.rb @@ -0,0 +1,24 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'difference' 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}) } + 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([]) } + 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 '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/dirname_spec.rb b/spec/functions/dirname_spec.rb new file mode 100644 index 000000000..ef8c8a05a --- /dev/null +++ b/spec/functions/dirname_spec.rb @@ -0,0 +1,22 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'dirname' do + 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}) } + 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') } + + 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 +end diff --git a/spec/functions/dos2unix_spec.rb b/spec/functions/dos2unix_spec.rb new file mode 100644 index 000000000..26abe1204 --- /dev/null +++ b/spec/functions/dos2unix_spec.rb @@ -0,0 +1,54 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'dos2unix' do + context 'when checking parameter validity' do + it { is_expected.not_to be_nil } + + it do + expect(subject).to run.with_params.and_raise_error(ArgumentError, %r{Wrong number of arguments}) + end + + it do + expect(subject).to run.with_params('one', 'two').and_raise_error(ArgumentError, %r{Wrong number of arguments}) + end + + it do + expect(subject).to run.with_params([]).and_raise_error(Puppet::ParseError, %r{Requires string as argument}) + end + + it do + expect(subject).to run.with_params({}).and_raise_error(Puppet::ParseError, %r{Requires string as argument}) + end + + it do + expect(subject).to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires string as argument}) + end + end + + context 'when converting from dos to unix format' do + sample_text = "Hello\r\nWorld\r\n" + desired_output = "Hello\nWorld\n" + + it 'outputs unix format' do + expect(subject).to run.with_params(sample_text).and_return(desired_output) + end + end + + context 'with internationalization (i18N) values' do + sample_text_utf8 = "Ħ℮ļłǿ\r\nשׁөŕłđ\r\n" + desired_output_utf8 = "Ħ℮ļłǿ\nשׁөŕłđ\n" + + sample_text_doublebyte = "こんにちは\r\n世界\r\n" + desired_output_doublebyte = "こんにちは\n世界\n" + + it 'outputs uft8 string' do + expect(subject).to run.with_params(sample_text_utf8).and_return(desired_output_utf8) + end + + it 'outputs double byte string' do + 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 new file mode 100644 index 000000000..058f9a77a --- /dev/null +++ b/spec/functions/end_with_spec.rb @@ -0,0 +1,16 @@ +# frozen_string_literal: true + +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 + 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 +end diff --git a/spec/functions/ensure_packages_spec.rb b/spec/functions/ensure_packages_spec.rb index a13c28216..8a4bc9869 100644 --- a/spec/functions/ensure_packages_spec.rb +++ b/spec/functions/ensure_packages_spec.rb @@ -1,46 +1,95 @@ -#! /usr/bin/env ruby +# frozen_string_literal: true require 'spec_helper' -require 'rspec-puppet' -describe 'ensure_packages' do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } +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']) } - describe 'argument handling' do - it 'fails with no arguments' do - expect { - scope.function_ensure_packages([]) - }.to raise_error(Puppet::ParseError, /0 for 1/) - end + 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 + before(:each) { subject.execute('facter') } - it 'accepts an array of values' do - scope.function_ensure_packages([['foo']]) + # 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('installed') } end - it 'accepts a single package name as a string' do - scope.function_ensure_packages(['foo']) + describe 'after running ensure_package("facter", { "provider" => "gem" })' do + 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 } + it { expect(-> { catalogue }).to contain_package('facter').with_ensure('installed').with_provider('gem') } end end - context 'given a catalog containing Package[puppet]{ensure => absent}' do - let :pre_condition do - 'package { puppet: ensure => absent }' + 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( + { + '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 + 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') } + it { expect(-> { catalogue }).to contain_package('ρǻ¢κầģẻ').with('ensure' => 'absent') } 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"} + 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 'given a clean catalog' do - 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") + 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" => "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('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 diff --git a/spec/functions/ensure_resource_spec.rb b/spec/functions/ensure_resource_spec.rb index 2e8aefc52..9b04db6b6 100644 --- a/spec/functions/ensure_resource_spec.rb +++ b/spec/functions/ensure_resource_spec.rb @@ -1,64 +1,152 @@ -#! /usr/bin/env ruby -S rspec +# frozen_string_literal: true + require 'spec_helper' -require 'rspec-puppet' describe 'ensure_resource' do - 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 { 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}) } + + 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) } end - describe 'when compared against a resource with no attributes' do - let :pre_condition do - 'user { "dan": }' + it { + pending('should not accept numbers as arguments') + expect(subject).to run.with_params(1, 2, 3).and_raise_error(Puppet::ParseError) + } + + context 'when given an empty catalog' do + describe 'after running ensure_resource("user", "username1", {})' do + 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 - 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]' + + describe 'after running ensure_resource("user", "username1", { gid => undef })' do + 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 } + it { expect(-> { catalogue }).to contain_user('username1').without_gid } 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 - # 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) } + describe 'after running ensure_resource("user", "username1", { ensure => present, gid => undef })' do + 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') } + it { expect(-> { catalogue }).to contain_user('username1').without_gid } + end + + 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 + it { expect(-> { catalogue }).to contain_test__deftype('foo').without_ensure } + end 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]' + context 'when given a catalog with UTF8 chars' do + describe 'after running ensure_resource("user", "Şắოрŀễ Ţëם", {})' do + 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.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 } + it { expect(-> { catalogue }).to contain_user('Şắოрŀễ Ţëם').without_gid } + end + + describe 'after running ensure_resource("user", "Şắოрŀễ Ţëם", { ensure => present, gid => undef })' do + 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') } + it { expect(-> { catalogue }).to contain_user('Şắოрŀễ Ţëם').without_gid } 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 }' + 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 + 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.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') } + it { expect(-> { catalogue }).to contain_user('username2').without_ensure } 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]' + + describe 'after running ensure_resource("user", "username1", { gid => undef })' do + 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.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') } + it { expect(-> { catalogue }).to contain_user('username2').without_ensure } + end + + describe 'when providing already set params' do + let(:params) { { 'ensure' => 'present' } } + + 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) } + it { expect(-> { catalogue }).to contain_user('username2').with(params) } + end + + context 'when trying to add params' do + it { + 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}) + } + end + end + + context 'when given a catalog with "test::deftype { foo: }"' do + let(:pre_condition) { 'define test::deftype { } test::deftype { "foo": }' } + + describe 'after running ensure_resource("test::deftype", "foo", {})' do + 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 - describe 'when compared against existing resources with attributes' do - let :pre_condition do - 'user { "dan": ensure => present; "alex": ensure => present }' + if Puppet::Util::Package.versioncmp(Puppet.version, '6.0.0') < 0 + def undef_value + :undef + end + else + def undef_value + nil 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 end diff --git a/spec/functions/ensure_resources_spec.rb b/spec/functions/ensure_resources_spec.rb new file mode 100644 index 000000000..cf4de9e48 --- /dev/null +++ b/spec/functions/ensure_resources_spec.rb @@ -0,0 +1,29 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'ensure_resources' do + 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}) } + + describe 'given a title hash of multiple resources' do + 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') } + 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(: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') } + it { expect(-> { catalogue }).to contain_user('dan').with('gid' => 'mygroup', 'uid' => '600') } + end +end diff --git a/spec/functions/extname_spec.rb b/spec/functions/extname_spec.rb new file mode 100644 index 000000000..bca462998 --- /dev/null +++ b/spec/functions/extname_spec.rb @@ -0,0 +1,18 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'stdlib::extname' do + 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}) } + 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 diff --git a/spec/functions/fqdn_rand_string_spec.rb b/spec/functions/fqdn_rand_string_spec.rb new file mode 100644 index 000000000..d19b28cbb --- /dev/null +++ b/spec/functions/fqdn_rand_string_spec.rb @@ -0,0 +1,57 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'stdlib::fqdn_rand_string' do + let(:default_charset) { %r{\A[a-zA-Z0-9]{100}\z} } + + 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}) } + 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 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_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}) } + + 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 + + context 'on a node named example.com' do + let(:fqdn) { 'example.com' } + + 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 + + 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 + end +end diff --git a/spec/functions/fqdn_rotate_spec.rb b/spec/functions/fqdn_rotate_spec.rb new file mode 100644 index 000000000..7906c42c2 --- /dev/null +++ b/spec/functions/fqdn_rotate_spec.rb @@ -0,0 +1,74 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'fqdn_rotate' do + 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}) } + 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('ã') } + + it { is_expected.to run.with_params([]).and_return([]) } + it { is_expected.to run.with_params(['a']).and_return(['a']) } + + it 'rotates a string and the result should be the same size' do + expect(fqdn_rotate('asdf').size).to eq(4) + 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') + 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 '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 'accepts objects which extend String' do + result = fqdn_rotate(AlsoString.new('asdf')) + expect(result).to eq('dfas') + end + + it 'uses the Puppet::Util.deterministic_rand function' do + 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 + + 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 + + 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 + allow(subject.func.closure_scope).to receive(:[]).with('facts').and_return({ 'networking' => { 'fqdn' => host } }) + + function_args = [value] + extra + scope.call_function('fqdn_rotate', function_args) + end +end diff --git a/spec/functions/fqdn_uuid_spec.rb b/spec/functions/fqdn_uuid_spec.rb new file mode 100644 index 000000000..a15751f6f --- /dev/null +++ b/spec/functions/fqdn_uuid_spec.rb @@ -0,0 +1,18 @@ +# frozen_string_literal: true + +require 'spec_helper' + +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('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/get_module_path_spec.rb b/spec/functions/get_module_path_spec.rb new file mode 100644 index 000000000..25740380a --- /dev/null +++ b/spec/functions/get_module_path_spec.rb @@ -0,0 +1,62 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'get_module_path' 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, 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 + class StubModule + attr_reader :path + + def initialize(path) + @path = path + end + 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) do + Puppet[:modulepath] = modulepath + end + + context 'when in the default environment' do + 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 + 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" + + expect(subject).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) do + allow(Puppet::Module).to receive(:find).with('foo', 'test').and_return(path_of_module_foo) + end + + it 'runs against foo' do + 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" + expect(subject).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 d9c50a6c2..eee123d9a 100644 --- a/spec/functions/getparam_spec.rb +++ b/spec/functions/getparam_spec.rb @@ -1,34 +1,36 @@ -#! /usr/bin/env ruby -S rspec +# frozen_string_literal: true + require 'spec_helper' -require 'rspec-puppet' 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('') - end + 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}) } + 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": }' } + + 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 - describe 'when compared against a resource with no params' do - let :pre_condition do - 'user { "dan": }' - end - it do - should run.with_params('User[dan]', 'shell').and_return('') - end + + describe 'when compared against a user resource with params' do + let(:pre_condition) { 'user { "one": ensure => present, shell => "/bin/sh", managehome => false, }' } + + 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 { is_expected.to run.with_params('User[one]', 'managehome').and_return(false) } end - describe 'when compared against a resource with params' do - let :pre_condition do - 'user { "dan": ensure => present, shell => "/bin/sh", managehome => false}' - 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) - 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/glob_spec.rb b/spec/functions/glob_spec.rb new file mode 100644 index 000000000..a057122ca --- /dev/null +++ b/spec/functions/glob_spec.rb @@ -0,0 +1,13 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'glob' do + 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([]) } + 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 diff --git a/spec/functions/grep_spec.rb b/spec/functions/grep_spec.rb new file mode 100644 index 000000000..b8e8e2efe --- /dev/null +++ b/spec/functions/grep_spec.rb @@ -0,0 +1,25 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'grep' 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').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + + it { + pending('grep does not actually check this, and raises NoMethodError instead') + 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') + 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) } + 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/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 diff --git a/spec/functions/has_interface_with_spec.rb b/spec/functions/has_interface_with_spec.rb new file mode 100644 index 000000000..16e90447f --- /dev/null +++ b/spec/functions/has_interface_with_spec.rb @@ -0,0 +1,147 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'has_interface_with' do + 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}) } + + # 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) 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) } + end + + context 'when on Linux Systems' do + let(:facts) do + { + '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.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('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 diff --git a/spec/functions/has_ip_address_spec.rb b/spec/functions/has_ip_address_spec.rb new file mode 100644 index 000000000..7256e7518 --- /dev/null +++ b/spec/functions/has_ip_address_spec.rb @@ -0,0 +1,32 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'has_ip_address' do + it { is_expected.not_to be_nil } + 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 + { + 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_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 new file mode 100644 index 000000000..c8352272e --- /dev/null +++ b/spec/functions/has_ip_network_spec.rb @@ -0,0 +1,31 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'has_ip_network' do + it { is_expected.not_to be_nil } + 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 + { + 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_raise_error(ArgumentError, %r{parameter 'ip_network' expects a match}) } + end +end diff --git a/spec/functions/intersection_spec.rb b/spec/functions/intersection_spec.rb new file mode 100644 index 000000000..6e1664609 --- /dev/null +++ b/spec/functions/intersection_spec.rb @@ -0,0 +1,24 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'intersection' do + 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) } + 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(['ōŋể', 'ŧשợ', 'ţђŕẽё'], ['ŧשợ', 'ţђŕẽё']).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/ip_in_range_spec.rb b/spec/functions/ip_in_range_spec.rb new file mode 100644 index 000000000..900d59023 --- /dev/null +++ b/spec/functions/ip_in_range_spec.rb @@ -0,0 +1,19 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'stdlib::ip_in_range' do + describe 'signature validation' do + 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}) } + 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 diff --git a/spec/functions/is_a_spec.rb b/spec/functions/is_a_spec.rb new file mode 100644 index 000000000..bd689c7ca --- /dev/null +++ b/spec/functions/is_a_spec.rb @@ -0,0 +1,34 @@ +# frozen_string_literal: true + +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 be_nil } + end + end +end + +if Puppet.version.to_f >= 4.0 + describe 'is_a' 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) } + + it 'succeeds when comparing a string and a string' do + expect(subject).to run.with_params('hello world', String).and_return(true) + end + + it 'fails when comparing an integer and a string' do + 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| + expect(subject).to run.with_params(comparison_value, String).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 new file mode 100644 index 000000000..f23825391 --- /dev/null +++ b/spec/functions/join_keys_to_values_spec.rb @@ -0,0 +1,36 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'join_keys_to_values' do + 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}) } + 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 '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 + + 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 + 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'] + expect(subject).to run.with_params({ 'key1' => 'value1', 'key2' => ['value2', 'value3'] }, ' ').and_return(expected_result) + end +end diff --git a/spec/functions/load_module_metadata_spec.rb b/spec/functions/load_module_metadata_spec.rb new file mode 100644 index 000000000..6a8124a0f --- /dev/null +++ b/spec/functions/load_module_metadata_spec.rb @@ -0,0 +1,53 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'load_module_metadata' 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', 'three').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + + 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 + 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}).and_return('{"ĭďèʼnţĩƒіểя": "ċơņťęאּť ỡƒ ţħíš - +この文字"}') + end + + let(:prefix) { 'C:' if Puppet::Util::Platform.windows? } + + 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(: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') + expect(result['name']).to eq('spencer-science') + end + + 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(: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(:exist?).with("#{prefix}/path/to/module/metadata.json").and_return(false) + result = subject.execute('science', true) + expect(result).to eq({}) + end + end + end +end diff --git a/spec/functions/loadjson_spec.rb b/spec/functions/loadjson_spec.rb new file mode 100644 index 000000000..17d01e451 --- /dev/null +++ b/spec/functions/loadjson_spec.rb @@ -0,0 +1,179 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'loadjson' 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) } + + 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 + 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 + let(:filename) do + if Puppet::Util::Platform.windows? + 'C:/tmp/doesnotexist' + else + '/tmp/doesnotexist' + end + 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 + else + allow(JSON).to receive(:parse).never # rubocop:disable RSpec/ReceiveNever + 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('デフォルト' => '値') } + end + + context 'when an existing file is specified' do + let(:filename) do + if Puppet::Util::Platform.windows? + 'C:/tmp/doesexist' + else + '/tmp/doesexist' + end + end + let(:data) { { 'key' => 'value', 'ķęŷ' => 'νậŀųề', 'キー' => '値' } } + 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 + 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 + + context 'when the file could not be parsed' do + let(:filename) do + if Puppet::Util::Platform.windows? + 'C:/tmp/doesexist' + else + '/tmp/doesexist' + end + end + 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 + 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 + + 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) + if Puppet::PUPPETVERSION[0].to_i < 8 + expect(PSON).to receive(:load).with(json).and_return(data).once + else + expect(JSON).to receive(:parse).with(json).and_return(data).once + end + expect(subject).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) + if Puppet::PUPPETVERSION[0].to_i < 8 + expect(PSON).to receive(:load).with(json).and_return(data).once + else + expect(JSON).to receive(:parse).with(json).and_return(data).once + end + expect(subject).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) + if Puppet::PUPPETVERSION[0].to_i < 8 + expect(PSON).to receive(:load).with(json).and_return(data).once + else + expect(JSON).to receive(:parse).with(json).and_return(data).once + end + expect(subject).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) + if Puppet::PUPPETVERSION[0].to_i < 8 + expect(PSON).to receive(:load).with(json).once.and_raise StandardError, 'Something terrible have happened!' + else + 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') + } + 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' + expect(subject).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 new file mode 100644 index 000000000..0eff7100e --- /dev/null +++ b/spec/functions/loadyaml_spec.rb @@ -0,0 +1,163 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'loadyaml' 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) } + + context 'when a non-existing file is specified' do + 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(: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(: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(: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, with default specified' do + let(:tempfile) { Tempfile.new } + let(:filename) { tempfile.path } + let(:yaml) do + <<~YAML + ,,,, + YAML + end + + 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(: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 + + 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, basic_auth).and_return(yaml) + 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 + + 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, aliases: true).and_return(data).once + expect(subject).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, aliases: true).and_return(data).once + expect(subject).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(:basic_auth) { { http_basic_authentication: ['', ''] } } + let(:yaml) { 'Dummy YAML' } + + it { + expect(OpenURI).to receive(:open_uri).with(filename, basic_auth).and_return(yaml) + 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 + + 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, basic_auth).and_raise OpenURI::HTTPError, '404 File not Found' + 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 diff --git a/spec/functions/member_spec.rb b/spec/functions/member_spec.rb new file mode 100644 index 000000000..244c2eea5 --- /dev/null +++ b/spec/functions/member_spec.rb @@ -0,0 +1,29 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'member' 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([]).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + + it { + pending('Current implementation ignores parameters after the first.') + 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) } + 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([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) } +end diff --git a/spec/functions/merge_spec.rb b/spec/functions/merge_spec.rb new file mode 100644 index 000000000..cbe00ee10 --- /dev/null +++ b/spec/functions/merge_spec.rb @@ -0,0 +1,92 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'stdlib::merge' do + it { is_expected.not_to be_nil } + + it { + expect(subject).to run \ + .with_params({}, 'two') \ + .and_raise_error( + ArgumentError, \ + Regexp.new(Regexp.escape("rejected: parameter 'args' expects a value of type Undef, Hash[Scalar, Any], or String[0, 0], got String")), + ) + } + + it { + 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 { + 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') + } + + 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 + + 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 { + 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 { + expect(subject).to run \ + .with_params([1, 2, 3]) \ + .with_lambda { |_hsh, val| { val => val } } \ + .and_return(1 => 1, 2 => 2, 3 => 3) + } + + it { + 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 { + expect(subject).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 { + 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 { + 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 { + 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') + } + end +end diff --git a/spec/functions/nested_values_spec.rb b/spec/functions/nested_values_spec.rb new file mode 100644 index 000000000..93ebabfbc --- /dev/null +++ b/spec/functions/nested_values_spec.rb @@ -0,0 +1,12 @@ +# frozen_string_literal: true + +require 'spec_helper' + +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']) } + 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 diff --git a/spec/functions/num2bool_spec.rb b/spec/functions/num2bool_spec.rb new file mode 100644 index 000000000..ad87b45f0 --- /dev/null +++ b/spec/functions/num2bool_spec.rb @@ -0,0 +1,25 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'num2bool' 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(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) } + 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, %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 new file mode 100644 index 000000000..e1ee6e41a --- /dev/null +++ b/spec/functions/os_version_gte_spec.rb @@ -0,0 +1,56 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'stdlib::os_version_gte' do + context 'on Debian 9' do + let(:facts) do + { + os: { + name: 'Debian', + release: { major: '9' } + } + } + 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(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 + + context 'on Ubuntu 16.04' do + let(:facts) do + { + os: { + name: 'Ubuntu', + release: { major: '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(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(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 + + context 'with invalid params' do + let(:facts) do + { + os: { + name: 'Ubuntu', + release: { major: '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/parsehocon_spec.rb b/spec/functions/parsehocon_spec.rb new file mode 100644 index 000000000..6448cbc5b --- /dev/null +++ b/spec/functions/parsehocon_spec.rb @@ -0,0 +1,10 @@ +# frozen_string_literal: true + +require 'spec_helper' + +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) } + it { is_expected.to run.with_params('invalid', 'default').and_return('default') } +end diff --git a/spec/functions/parsejson_spec.rb b/spec/functions/parsejson_spec.rb new file mode 100644 index 000000000..6db0f9d95 --- /dev/null +++ b/spec/functions/parsejson_spec.rb @@ -0,0 +1,76 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'parsejson' do + it 'exists' do + expect(subject).not_to be_nil + end + + it 'raises an error if called without any arguments' do + 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 + expect(subject).to run.with_params('null').and_return(nil) + end + + it 'is able to parse JSON that is a string' do + expect(subject).to run.with_params('"a string"').and_return('a string') + end + + it 'is able to parse JSON data with a Hash' do + 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 + 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| + 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 + 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 + expect(subject).to run.with_params('{"×":"これ","ý":"記号","です":{"©":["Á","ß"]}}') + .and_return('×' => 'これ', 'ý' => '記号', 'です' => { '©' => ['Á', 'ß'] }) + end + + it 'does not return the default value if the data was parsed correctly' do + 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 + expect(subject).to run.with_params('error') + .and_raise_error(Puppet::Util::Json::ParseError) + end + + it 'supports a structure for a default value' do + 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 + expect(subject).to run.with_params(value, 'default_value') + .and_return('default_value') + end + end + end +end diff --git a/spec/functions/parsepson_spec.rb b/spec/functions/parsepson_spec.rb new file mode 100644 index 000000000..cff940c84 --- /dev/null +++ b/spec/functions/parsepson_spec.rb @@ -0,0 +1,73 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'parsepson' do + if Puppet::Util::Package.versioncmp(Puppet.version, '8.0.0').negative? + it 'exists' do + expect(subject).not_to be_nil + end + + it 'raises an error if called without any arguments' do + 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 + 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 + 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| + 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 + 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 + expect(subject).to run.with_params('{"×":"これ","ý":"記号","です":{"©":["Á","ß"]}}') + .and_return('×' => 'これ', 'ý' => '記号', 'です' => { '©' => ['Á', 'ß'] }) + end + + it 'does not return the default value if the data was parsed correctly' do + 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 + 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 + expect(subject).to run.with_params('invalid', 'default_value') + .and_return('default_value') + end + + it 'supports a structure for a default value' do + expect(subject).to run.with_params('invalid', 'a' => '1') + .and_return('a' => '1') + 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 diff --git a/spec/functions/parseyaml_spec.rb b/spec/functions/parseyaml_spec.rb new file mode 100644 index 000000000..2096f4758 --- /dev/null +++ b/spec/functions/parseyaml_spec.rb @@ -0,0 +1,76 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'parseyaml' do + it 'exists' do + expect(subject).not_to be_nil + end + + it 'raises an error if called without any arguments' do + 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| + 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 + 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 + 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 + 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 + 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 + 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 + 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 + 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 + 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 + expect(subject).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 new file mode 100644 index 000000000..5062596dd --- /dev/null +++ b/spec/functions/pick_default_spec.rb @@ -0,0 +1,42 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'pick_default' do + 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') } + 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') } + 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).and_return({}) } + 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 || + Puppet::Util::Package.versioncmp(Puppet.version, '5.5.7') == 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 + (v.nil? || v == :undef) ? '' : v + end + end +end diff --git a/spec/functions/pick_spec.rb b/spec/functions/pick_spec.rb new file mode 100644 index 000000000..5e6ed1bde --- /dev/null +++ b/spec/functions/pick_spec.rb @@ -0,0 +1,19 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'pick' do + 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') } + 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') } + + 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 +end diff --git a/spec/functions/powershell_escape_spec.rb b/spec/functions/powershell_escape_spec.rb new file mode 100644 index 000000000..20340e741 --- /dev/null +++ b/spec/functions/powershell_escape_spec.rb @@ -0,0 +1,27 @@ +# frozen_string_literal: true + +require 'spec_helper' + +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{'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 + 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 { + expect(subject).to run.with_params('~`!@#$%^&*()_-=[]\{}|;\':",./<>?') + .and_return('~``!@#`$%^&*()_-=[]\{}`|;`\':\\`",./<>?') + } + end +end diff --git a/spec/functions/prefix_spec.rb b/spec/functions/prefix_spec.rb new file mode 100644 index 000000000..0615a3f11 --- /dev/null +++ b/spec/functions/prefix_spec.rb @@ -0,0 +1,34 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'prefix' 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 { + pending('Current implementation ignores parameters after the second.') + 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}) } + 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([], '').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 { + expect(subject).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/pw_hash_spec.rb b/spec/functions/pw_hash_spec.rb new file mode 100644 index 000000000..5e9af8921 --- /dev/null +++ b/spec/functions/pw_hash_spec.rb @@ -0,0 +1,114 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'pw_hash' do + 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) } + 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, %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, %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 + 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 + + context 'when the second argument is not a string' do + 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, %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, %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, %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, %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}) } + 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 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 + + 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') } + 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 { + 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') } + end + end + end +end diff --git a/spec/functions/range_spec.rb b/spec/functions/range_spec.rb new file mode 100644 index 000000000..7d266f53a --- /dev/null +++ b/spec/functions/range_spec.rb @@ -0,0 +1,173 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'range' do + 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) } + + it { + pending('Current implementation ignores parameters after the third.') + 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) } + 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' + expect(subject).to run.with_params.and_raise_error(ArgumentError) + } + + it { + pending 'the puppet 4 implementation' + expect(subject).to run.with_params('').and_raise_error(ArgumentError) + } + + it { + pending 'the puppet 4 implementation' + expect(subject).to run.with_params({}).and_raise_error(ArgumentError) + } + + it { + pending 'the puppet 4 implementation' + expect(subject).to run.with_params([]).and_raise_error(ArgumentError) + } + + it { + pending 'the puppet 4 implementation' + expect(subject).to run.with_params(true).and_raise_error(ArgumentError) + } + + it { + expect(subject).to run.with_params(1, 2, 'foo').and_raise_error(ArgumentError) + } + + it { + pending 'the puppet 4 implementation' + expect(subject).to run.with_params(1, 2, []).and_raise_error(ArgumentError) + } + + it { + pending 'the puppet 4 implementation' + expect(subject).to run.with_params(1, 2, {}).and_raise_error(ArgumentError) + } + + it { + pending 'the puppet 4 implementation' + expect(subject).to run.with_params(1, 2, true).and_raise_error(ArgumentError) + } + + it { + pending 'the puppet 4 implementation' + expect(subject).to run.with_params(1, 2, 3, 4).and_raise_error(ArgumentError) + } + + it { + pending 'the puppet 4 implementation' + expect(subject).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', '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('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 + + 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 + + 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 + + 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 + + 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]) } + 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 + + 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 + + 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 '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 + 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 + 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 + 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 new file mode 100644 index 000000000..fea5c8aa5 --- /dev/null +++ b/spec/functions/regexpescape_spec.rb @@ -0,0 +1,45 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'regexpescape' do + describe 'signature validation' 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 { + pending('Current implementation ignores parameters after the first.') + 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}) } + 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 Regexp.escape function' do + expect(Regexp).to receive(:escape).with('regexp_string').and_return('escaped_regexp_string').once + expect(subject).to run.with_params('regexp_string').and_return('escaped_regexp_string') + end + end + + describe 'handling classes derived from String' do + 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 + expect(subject).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']) } + + 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 + end +end diff --git a/spec/functions/reject_spec.rb b/spec/functions/reject_spec.rb new file mode 100644 index 000000000..90fc1d190 --- /dev/null +++ b/spec/functions/reject_spec.rb @@ -0,0 +1,24 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'reject' 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([], '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') + 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') + 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([]) } + 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 new file mode 100644 index 000000000..d4740945b --- /dev/null +++ b/spec/functions/reverse_spec.rb @@ -0,0 +1,37 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'reverse' 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 { + pending('Current implementation ignores parameters after the first.') + 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}) } + 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('').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 'calls its reverse method' do + value = AlsoString.new('asdfghjkl') + 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 +end diff --git a/spec/functions/seeded_rand_spec.rb b/spec/functions/seeded_rand_spec.rb new file mode 100644 index 000000000..43e22f578 --- /dev/null +++ b/spec/functions/seeded_rand_spec.rb @@ -0,0 +1,25 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'stdlib::seeded_rand' do + it { is_expected.not_to be_nil } + 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\]}) } + 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) } + 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 diff --git a/spec/functions/seeded_rand_string_spec.rb b/spec/functions/seeded_rand_string_spec.rb new file mode 100644 index 000000000..3c2c49bb5 --- /dev/null +++ b/spec/functions/seeded_rand_string_spec.rb @@ -0,0 +1,37 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'stdlib::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.+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(%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 + 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(:'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 +end diff --git a/spec/functions/sha256_spec.rb b/spec/functions/sha256_spec.rb new file mode 100644 index 000000000..5c9e2e3ce --- /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 be_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 diff --git a/spec/functions/shell_escape_spec.rb b/spec/functions/shell_escape_spec.rb new file mode 100644 index 000000000..cd90c501a --- /dev/null +++ b/spec/functions/shell_escape_spec.rb @@ -0,0 +1,32 @@ +# frozen_string_literal: true + +require 'spec_helper' + +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{'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 + 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 { + expect(subject).to run.with_params('~`!@#$%^&*()_-=[]\{}|;\':",./<>?') + .and_return('\~\`\!@\#\$\%\^\&\*\(\)_-\=\[\]\\\\\{\}\|\;\\\':\",./\<\>\?') + } + end + + 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 +end diff --git a/spec/functions/shell_join_spec.rb b/spec/functions/shell_join_spec.rb new file mode 100644 index 000000000..03144c3ee --- /dev/null +++ b/spec/functions/shell_join_spec.rb @@ -0,0 +1,33 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'shell_join' do + 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) } + 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(['foo', 'bar baz']).and_return('foo bar\ baz') } + + it { + expect(subject).to run.with_params(['~`!@#$', '%^&*()_-=', '[]\{}|;\':"', ',./<>?']) + .and_return('\~\`\!@\#\$ \%\^\&\*\(\)_-\= \[\]\\\\\{\}\|\;\\\':\" ,./\<\>\?') + } + + 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 + 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..0ad9b0bcd --- /dev/null +++ b/spec/functions/shell_split_spec.rb @@ -0,0 +1,37 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'shell_split' do + 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) } + 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 '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 { + expect(subject).to run.with_params('\~\`\!@\#\$\%\^\&\*\(\)_\+-\=\[\]\\\\\{\}\|\;\\\':\",./\<\>\?') + .and_return(['~`!@#$%^&*()_+-=[]\{}|;\':",./<>?']) + } + + it { + expect(subject).to run.with_params('\~\`\!@\#\$ \%\^\&\*\(\)_\+-\= \[\]\\\\\{\}\|\;\\\':\" ,./\<\>\?') + .and_return(['~`!@#$', '%^&*()_+-=', '[]\{}|;\':"', ',./<>?']) + } + + 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 + end +end diff --git a/spec/functions/shuffle_spec.rb b/spec/functions/shuffle_spec.rb new file mode 100644 index 000000000..97459ab95 --- /dev/null +++ b/spec/functions/shuffle_spec.rb @@ -0,0 +1,61 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'shuffle' 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 { + pending('Current implementation ignores parameters after the first.') + 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}) } + 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 + before(:each) { srand(2) } + + 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']) } + + 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']) } + + 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('lakfdgjsh') } + end + end + 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 diff --git a/spec/functions/squeeze_spec.rb b/spec/functions/squeeze_spec.rb new file mode 100644 index 000000000..04f45bcfb --- /dev/null +++ b/spec/functions/squeeze_spec.rb @@ -0,0 +1,54 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'squeeze' 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('', '', '').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) } + + 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 + + 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('ậậậậậậậậậậậậậậậậậ語語語語©') } + end + + context 'when squeezing values in an array' do + it { + expect(subject).to run \ + .with_params(['', 'a', 'aaaaaaaaa', 'aaaaaaaaabbbbbbbbbbcccccccccc']) \ + .and_return(['', 'a', 'a', 'abc']) + } + + it { + expect(subject).to run \ + .with_params(['', 'a', 'aaaaaaaaa', 'aaaaaaaaabbbbbbbbbbcccccccccc'], 'a') \ + .and_return(['', 'a', 'a', 'abbbbbbbbbbcccccccccc']) + } + + it { + expect(subject).to run \ + .with_params(['', 'a', 'aaaaaaaaa', 'aaaaaaaaabbbbbbbbbbcccccccccc'], 'b-c') \ + .and_return(['', 'a', 'aaaaaaaaa', 'aaaaaaaaabc']) + } + end + + 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') # rubocop:disable RSpec/AnyInstance + expect(subject).to run.with_params(value).and_return('foo') + end + end +end diff --git a/spec/functions/startswith_spec.rb b/spec/functions/startswith_spec.rb new file mode 100644 index 000000000..ebd00553e --- /dev/null +++ b/spec/functions/startswith_spec.rb @@ -0,0 +1,13 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'stdlib::start_with' do + 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}) } + + 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 diff --git a/spec/functions/stdlib_deferrable_epp_spec.rb b/spec/functions/stdlib_deferrable_epp_spec.rb new file mode 100644 index 000000000..022ac031a --- /dev/null +++ b/spec/functions/stdlib_deferrable_epp_spec.rb @@ -0,0 +1,31 @@ +# frozen_string_literal: true + +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 { + expect(subject).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]) + # This kind_of matcher requires https://github.com/puppetlabs/rspec-puppet/pull/24 + 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/stdlib_ensure_spec.rb b/spec/functions/stdlib_ensure_spec.rb new file mode 100644 index 000000000..b81d744e0 --- /dev/null +++ b/spec/functions/stdlib_ensure_spec.rb @@ -0,0 +1,32 @@ +# frozen_string_literal: true + +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') } + 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 + 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 diff --git a/spec/functions/str2bool_spec.rb b/spec/functions/str2bool_spec.rb new file mode 100644 index 000000000..9259910b1 --- /dev/null +++ b/spec/functions/str2bool_spec.rb @@ -0,0 +1,27 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'str2bool' 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 { + pending('Current implementation ignores parameters after the first.') + 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}) } + + describe 'when testing values that mean "true"' do + ['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| + it { is_expected.to run.with_params(value).and_return(false) } + end + end +end diff --git a/spec/functions/str2resource_spec.rb b/spec/functions/str2resource_spec.rb new file mode 100644 index 000000000..1c8582f0b --- /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 be_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 diff --git a/spec/functions/str2saltedpbkdf2_spec.rb b/spec/functions/str2saltedpbkdf2_spec.rb new file mode 100644 index 000000000..907b18509 --- /dev/null +++ b/spec/functions/str2saltedpbkdf2_spec.rb @@ -0,0 +1,25 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'str2saltedpbkdf2' 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) } + 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 Layout/LineLength + it { + 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 +end diff --git a/spec/functions/str2saltedsha512_spec.rb b/spec/functions/str2saltedsha512_spec.rb new file mode 100644 index 000000000..3b468fdb6 --- /dev/null +++ b/spec/functions/str2saltedsha512_spec.rb @@ -0,0 +1,47 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'str2saltedsha512' 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('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) } + + if Puppet::PUPPETVERSION[0].to_i < 8 + it { + expect(subject).to run.with_params('') + .and_return('0f8a612f4eeed08e47b3875d00f33c5688f7926298f2d9b5fe19d1323f910bc78b6f7b5892596d2fabaa65e7a8d99b3768c102610cf0432c4827eee01f09451e3fae4f7a') + } + + it { + expect(subject).to run.with_params('password') + .and_return('0f8a612f43134376566c5707718d600effcfb17581fc9d3fa64d7f447dfda317c174ffdb498d2c5bd5c2075dab41c9d7ada5afbdc6b55354980eb5ba61802371e6b64956') + } + + it { + expect(subject).to run.with_params('verylongpassword') + .and_return('0f8a612f7a448537540e062daa8621f9bae326ca8ccb899e1bdb10e7c218cebfceae2530b856662565fdc4d81e986fc50cfbbc46d50436610ed9429ff5e43f2c45b5d039') + } + else + it { + expect(subject).to run.with_params('') + .and_return('a85c9d6f8c1eb1a625fd59e3cbca7dc7ab04ff1758d19ab99f098446e14a0a2a42e11afd1f4d6f17adfe2c772a3e6a821ee66a2564711431e14da96a3bff44593cf158ab') + } + + it { + expect(subject).to run.with_params('password') + .and_return('a85c9d6ff4e4dd6655ec2922ee9752550f2df4dc370e9739dd94899f62be6a42cc31fbfce3d62be35e0e8482696c931f63fb9286cf7b13d283660720c55f2a6304d06958') + } + + it { + expect(subject).to run.with_params('verylongpassword') + .and_return('a85c9d6fb810d0b8311c9a065c026e3179ae91fee3dbaf556f297e2fda2a8e3d8dd363977f9ef5c9b5da0cd518a5151a4e537928533291d68c9539d4d4b83da53b22a869') + } + end + end +end diff --git a/spec/functions/suffix_spec.rb b/spec/functions/suffix_spec.rb new file mode 100644 index 000000000..04d42739a --- /dev/null +++ b/spec/functions/suffix_spec.rb @@ -0,0 +1,35 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'suffix' 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 { + pending('Current implementation ignores parameters after the second.') + 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}) } + 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([], '').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(['ỗńέ', 'ťשׂǿ', 'ŧҺř℮ə'], 'рổŝţ').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 { + expect(subject).to run \ + .with_params({ 'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3' }, 'post') \ + .and_return('key1post' => 'value1', 'key2post' => 'value2', 'key3post' => 'value3') + } +end diff --git a/spec/functions/swapcase_spec.rb b/spec/functions/swapcase_spec.rb new file mode 100644 index 000000000..6f3141b41 --- /dev/null +++ b/spec/functions/swapcase_spec.rb @@ -0,0 +1,49 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'swapcase' 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 { + pending('Current implementation ignores parameters after the first.') + 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}) } + 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') } + 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([]) } + + 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 'accepts objects which extend String' do + expect(subject).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 new file mode 100644 index 000000000..079bb0d30 --- /dev/null +++ b/spec/functions/time_spec.rb @@ -0,0 +1,23 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'time' do + it { is_expected.not_to be_nil } + + 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(: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) } + + 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 diff --git a/spec/functions/to_bytes_spec.rb b/spec/functions/to_bytes_spec.rb new file mode 100644 index 000000000..b86be5361 --- /dev/null +++ b/spec/functions/to_bytes_spec.rb @@ -0,0 +1,72 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'to_bytes' 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('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) } + 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('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('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, %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 + + # 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/to_json_pretty_spec.rb b/spec/functions/to_json_pretty_spec.rb new file mode 100644 index 000000000..f1a54e54b --- /dev/null +++ b/spec/functions/to_json_pretty_spec.rb @@ -0,0 +1,31 @@ +# frozen_string_literal: true + +require 'spec_helper' + +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") } + 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 { + 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") } + 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') + 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') + 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 new file mode 100644 index 000000000..06de89658 --- /dev/null +++ b/spec/functions/to_json_spec.rb @@ -0,0 +1,25 @@ +# frozen_string_literal: true + +require 'spec_helper' + +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') } + 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 { + 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('"‰"') } + 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_python_spec.rb b/spec/functions/to_python_spec.rb new file mode 100644 index 000000000..5dede9fcd --- /dev/null +++ b/spec/functions/to_python_spec.rb @@ -0,0 +1,28 @@ +# frozen_string_literal: true + +require 'spec_helper' + +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') } + 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 { + 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('"‰"') } + 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_ruby_spec.rb b/spec/functions/to_ruby_spec.rb new file mode 100644 index 000000000..846bd1b33 --- /dev/null +++ b/spec/functions/to_ruby_spec.rb @@ -0,0 +1,27 @@ +# frozen_string_literal: true + +require 'spec_helper' + +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') } + 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 { + 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('"‰"') } + 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_toml_spec.rb b/spec/functions/to_toml_spec.rb new file mode 100644 index 000000000..7347e0f2d --- /dev/null +++ b/spec/functions/to_toml_spec.rb @@ -0,0 +1,29 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'stdlib::to_toml' do + context 'fails on invalid params' do + it { is_expected.not_to be_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 diff --git a/spec/functions/to_yaml_spec.rb b/spec/functions/to_yaml_spec.rb new file mode 100644 index 000000000..3d8dfcd5d --- /dev/null +++ b/spec/functions/to_yaml_spec.rb @@ -0,0 +1,25 @@ +# frozen_string_literal: true + +require 'spec_helper' + +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}) } + 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") } + 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 { + 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") } + 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 diff --git a/spec/functions/type_of_spec.rb b/spec/functions/type_of_spec.rb new file mode 100644 index 000000000..a722aa688 --- /dev/null +++ b/spec/functions/type_of_spec.rb @@ -0,0 +1,27 @@ +# frozen_string_literal: true + +require 'spec_helper' + +if ENV['FUTURE_PARSER'] == 'yes' + 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 + end +end + +if Puppet.version.to_f >= 4.0 + 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) } + + it 'gives the type of a string' do + 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_a(Puppet::Pops::Types::PIntegerType) + end + end +end diff --git a/spec/functions/union_spec.rb b/spec/functions/union_spec.rb new file mode 100644 index 000000000..da552b8f9 --- /dev/null +++ b/spec/functions/union_spec.rb @@ -0,0 +1,27 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'union' do + describe 'argument checking' 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').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 '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/unix2dos_spec.rb b/spec/functions/unix2dos_spec.rb new file mode 100644 index 000000000..9224615ac --- /dev/null +++ b/spec/functions/unix2dos_spec.rb @@ -0,0 +1,47 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'unix2dos' do + context 'when checking parameter validity' do + it { is_expected.not_to be_nil } + + it do + expect(subject).to run.with_params.and_raise_error(ArgumentError, %r{Wrong number of arguments}) + end + + it do + expect(subject).to run.with_params('one', 'two').and_raise_error(ArgumentError, %r{Wrong number of arguments}) + end + + it do + expect(subject).to run.with_params([]).and_raise_error(Puppet::ParseError) + end + + it do + expect(subject).to run.with_params({}).and_raise_error(Puppet::ParseError) + end + + it do + expect(subject).to run.with_params(1).and_raise_error(Puppet::ParseError) + end + end + + context 'when converting from unix to dos format' do + sample_text = "Hello\nWorld\n" + desired_output = "Hello\r\nWorld\r\n" + + it 'outputs dos format' do + expect(subject).to run.with_params(sample_text).and_return(desired_output) + end + end + + context 'when converting from dos to dos format' do + sample_text = "Hello\r\nWorld\r\n" + desired_output = "Hello\r\nWorld\r\n" + + it 'outputs dos format' do + 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 new file mode 100644 index 000000000..5d7606121 --- /dev/null +++ b/spec/functions/uriescape_spec.rb @@ -0,0 +1,47 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'uriescape' do + # 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 be_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.') + 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}) } + 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 + expect(subject).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::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 + expect(subject).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']) } + 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 diff --git a/spec/functions/validate_augeas_spec.rb b/spec/functions/validate_augeas_spec.rb new file mode 100644 index 000000000..d238859bd --- /dev/null +++ b/spec/functions/validate_augeas_spec.rb @@ -0,0 +1,77 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'validate_augeas' do + if Puppet.features.augeas? + describe 'signature validation' 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('').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'], + ] + + inputs.each do |input| + it { is_expected.to run.with_params(*input) } + end + end + + 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. + inputs = [ + ["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, %r{validate_augeas.*?matched less than it should}) } + end + end + + 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'], + ] + + inputs.each do |input| + it { is_expected.to run.with_params(*input).and_raise_error(Puppet::ParseError, %r{#{input[3]}}) } + end + end + + 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 { is_expected.to run.with_params(*input) } + end + end + + 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 { 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_cmd_spec.rb b/spec/functions/validate_cmd_spec.rb new file mode 100644 index 000000000..e3e6155cc --- /dev/null +++ b/spec/functions/validate_cmd_spec.rb @@ -0,0 +1,49 @@ +# frozen_string_literal: true + +require 'spec_helper' + +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 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) } + + it { + pending('should implement stricter type checking') + expect(subject).to run.with_params([], '', '').and_raise_error(Puppet::ParseError, %r{content must be a string}) + } + + it { + pending('should implement stricter type checking') + expect(subject).to run.with_params('', [], '').and_raise_error(Puppet::ParseError, %r{checkscript must be a string}) + } + + it { + pending('should implement stricter type checking') + 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 { + 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)}) + } + + 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 { + 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)}) + } + + 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 new file mode 100644 index 000000000..2c3958dac --- /dev/null +++ b/spec/functions/validate_domain_name_spec.rb @@ -0,0 +1,37 @@ +# frozen_string_literal: true + +require 'spec_helper' + +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) } + 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') } + 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(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(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(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/functions/validate_email_address_spec.rb b/spec/functions/validate_email_address_spec.rb new file mode 100644 index 000000000..95a384508 --- /dev/null +++ b/spec/functions/validate_email_address_spec.rb @@ -0,0 +1,25 @@ +# frozen_string_literal: true + +require 'spec_helper' + +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) } + 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(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 diff --git a/spec/functions/validate_legacy_spec.rb b/spec/functions/validate_legacy_spec.rb new file mode 100644 index 000000000..e607b32f5 --- /dev/null +++ b/spec/functions/validate_legacy_spec.rb @@ -0,0 +1,46 @@ +# frozen_string_literal: true + +require 'spec_helper' + +if Puppet::Util::Package.versioncmp(Puppet.version, '4.4.0') >= 0 + describe 'validate_legacy' do + 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 + it 'passes with a deprecation warning' 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) + expect(subject).to run.with_params('Integer', 'validate_foo', 5) + end + end + + 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).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 + expect(subject).to run.with_params('Integer', 'validate_foo', '5') + end + end + + describe 'when passing in undef' 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) + expect(subject).to run.with_params('Optional[Integer]', 'validate_foo', :undef) + end + end + + 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).not_to receive(:function_validate_foo) + expect(Puppet).not_to receive(:notice) + expect(subject).to run.with_params('Optional[Integer]', 'validate_foo', :undef, 1, 'foo') + end + 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 100644 index 000000000..a9e102b7f --- /dev/null +++ b/spec/functions/validate_x509_rsa_key_pair_spec.rb @@ -0,0 +1,179 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'validate_x509_rsa_key_pair' do + let(:valid_cert) do + <<~DOC + -----BEGIN CERTIFICATE----- + MIIC9jCCAeCgAwIBAgIRAK11n3X7aypJ7FPM8UFyAeowCwYJKoZIhvcNAQELMBIx + EDAOBgNVBAoTB0FjbWUgQ28wHhcNMTUxMTIzMjIzOTU4WhcNMTYxMTIyMjIzOTU4 + WjASMRAwDgYDVQQKEwdBY21lIENvMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB + CgKCAQEAz9bY/piKahD10AiJSfbI2A8NG5UwRz0r9T/WfvNVdhgrsGFgNQjvpUoZ + nNJpQIHBbgMOiXqfATFjJl5FjEkSf7GUHohlGVls9MX2JmVvknzsiitd75H/EJd+ + N+k915lix8Vqmj8d1CTlbF/8tEjzANI67Vqw5QTuqebO7rkIUvRg6yiRfSo75FK1 + RinCJyl++kmleBwQZBInQyg95GvJ5JTqMzBs67DeeyzskDhTeTePRYVF2NwL8QzY + htvLIBERTNsyU5i7nkxY5ptUwgFUwd93LH4Q19tPqL5C5RZqXxhE51thOOwafm+a + W/cRkqYqV+tv+j1jJ3WICyF1JNW0BQIDAQABo0swSTAOBgNVHQ8BAf8EBAMCAKAw + EwYDVR0lBAwwCgYIKwYBBQUHAwEwDAYDVR0TAQH/BAIwADAUBgNVHREEDTALggls + b2NhbGhvc3QwCwYJKoZIhvcNAQELA4IBAQAzRo0hpVTrFQZLIXpwvKwZVGvJdCkV + P95DTsSk/VTGV+/YtxrRqks++hJZnctm2PbnTsCAoIP3AMx+vicCKiKrxvpsLU8/ + +6cowUbcuGMdSQktwDqbAgEhQlLsETll06w1D/KC+ejOc4+LRn3GQcEyGDtMk/EX + IeAvBZHr4/kVXWnfo6kzCLcku1f8yE/yDEFClZe9XV1Lk/s+3YfXVtNnMJJ1giZI + QVOe6CkmuQq+4AtIeW8aLkvlfp632jag1F77a1y+L268koKkj0hBMrtcErVQaxmq + xym0+soR4Tk4pTIGckeFglrLxkP2JpM/yTwSEAVlmG9vgTliYKyR0uMl + -----END CERTIFICATE----- + DOC + end + + let(:valid_key) do + <<~DOC + -----BEGIN RSA PRIVATE KEY----- + MIIEogIBAAKCAQEAz9bY/piKahD10AiJSfbI2A8NG5UwRz0r9T/WfvNVdhgrsGFg + NQjvpUoZnNJpQIHBbgMOiXqfATFjJl5FjEkSf7GUHohlGVls9MX2JmVvknzsiitd + 75H/EJd+N+k915lix8Vqmj8d1CTlbF/8tEjzANI67Vqw5QTuqebO7rkIUvRg6yiR + fSo75FK1RinCJyl++kmleBwQZBInQyg95GvJ5JTqMzBs67DeeyzskDhTeTePRYVF + 2NwL8QzYhtvLIBERTNsyU5i7nkxY5ptUwgFUwd93LH4Q19tPqL5C5RZqXxhE51th + OOwafm+aW/cRkqYqV+tv+j1jJ3WICyF1JNW0BQIDAQABAoIBADAiZ/r+xP+vkd5u + O61/lCBFzBlZQecdybJw6HJaVK6XBndA9hESUr4LHUdui6W+51ddKd65IV4bXAUk + zCKjQb+FFvLDT/bA+TTvLATUdTSN7hJJ3OWBAHuNOlQklof6JCB0Hi4+89+P8/pX + eKUgR/cmuTMDT/iaXdPHeqFbBQyA1ZpQFRjN5LyyJMS/9FkywuNc5wlpsArtc51T + gIKENUZCuPhosR+kMFc2iuTNvqZWPhvouSrmhi2O6nSqV+oy0+irlqSpCF2GsCI8 + 72TtLpq94Grrq0BEH5avouV+Lp4k83vO65OKCQKUFQlxz3Xkxm2U3J7KzxqnRtM3 + /b+cJ/kCgYEA6/yOnaEYhH/7ijhZbPn8RujXZ5VGJXKJqIuaPiHMmHVS5p1j6Bah + 2PcnqJA2IlLs3UloN+ziAxAIH6KCBiwlQ/uPBNMMaJsIjPNBEy8axjndKhKUpidg + R0OJ7RQqMShOJ8akrSfWdPtXC/GBuwCYE//t77GgZaIMO3FcT9EKA48CgYEA4Xcx + Fia0Jg9iyAhNmUOXI6hWcGENavMx01+x7XFhbnMjIKTZevFfTnTkrX6HyLXyGtMU + gHOn+k4PE/purI4ARrKO8m5wYEKqSIt4dBMTkIXXirfQjXgfjR8E4T/aPe5fOFZo + 7OYuxLRtzmG1C2sW4txwKAKX1LaWcVx/RLSttSsCgYBbcj8Brk+F6OJcqYFdzXGJ + OOlf5mSMVlopyg83THmwCqbZXtw8L6kAHqZrl5airmfDSJLuOQlMDoZXW+3u3mSC + d5TwVahVUN57YDgzaumBLyMZDqIz0MZqVy23hTzkV64Rk9R0lR9xrYQJyMhw4sYL + 2f0mCTsSpzz+O+t9so+i2QKBgEC38gMlwPhb2kMI/x1LZYr6uzUu5qcYf+jowy4h + KZKGwkKQj0zXFEB1FV8nvtpCP+irRmtIx6L13SYi8LnfWPzyLE4ynVdES5TfVAgd + obQOdzx+XwL8xDHCAaiWp5K3ZeXKB/xYZnxYPlzLdyh76Ond1OPnOqX4c16+6llS + c7pZAoGATd9NckT0XtXLEsF3IraDivq8dP6bccX2DNfS8UeEvRRrRwpFpSRrmuGb + jbG4yzoIX4RjQfj/z48hwhJB+cKiN9WwcPsFXtHe7v3F6BRwK0JUfrCiXad8/SGZ + KAf7Dfqi608zBdnPWHacre2Y35gPHB00nFQOLS6u46aBNSq07YA= + -----END RSA PRIVATE KEY----- + DOC + end + + let(:another_valid_key) do + <<~DOC + -----BEGIN RSA PRIVATE KEY----- + MIIEpAIBAAKCAQEAoISxYJBTPAeAzFnm+lE/ljLlmGal2Xr3vwZKkvJiuKA/m4QJ + 0ZNdtkBSDOVuG2dXVv6W4sChRtsCdvuVe7bjTYvlU8TWM3VEJDL9l9cRXScxxlKQ + Xwb35y1yV35NJfaK/jzm9KcErtQQs1RxvGlWRaohmLM8uQcuhjZfMsSlQoHQD5LX + sbPtk82RPyxYc1dj2vsaoi1VvuP2+jv4xLQOmNJY1bT5GTurqiltmxEtWhNNmGg0 + 2wtK00ifqLVO5HNc3gXQCDM2M99Sbmn1YtbrgsU9xMYfcPmvQvb+YoKskyoqck+c + HR//hi7vslbxABrny15LBkEfRc4TickphSGYXwIDAQABAoIBAATEzGw8/WwMIQRx + K06GeWgh7PZBHm4+m/ud2TtSXiJ0CE+7dXs3cJJIiOd/LW08/bhE6gCkjmYHfaRB + Ryicv1X/cPmzIFX5BuQ4a5ZGOmrVDkKBE27vSxAgJoR46RvWnjx9XLMp/xaekDxz + psldK8X4DvV1ZbltgDFWji947hvyqUtHdKnkQnc5j7aCIFJf9GMfzaeeDPMaL8WF + mVL4iy9EAOjNOHBshZj/OHyU5FbJ8ROwZQlCOiLCdFegftSIXt8EYDnjB3BdsALH + N6hquqrD7xDKyRbTD0K7lqxUubuMwTQpi61jZD8TBTXEPyFVAnoMpXkc0Y+np40A + YiIsR+kCgYEAyrc4Bh6fb9gt49IXGXOSRZ5i5+TmJho4kzIONrJ7Ndclwx9wzHfh + eGBodWaw5CxxQGMf4vEiaZrpAiSFeDffBLR+Wa2TFE5aWkdYkR34maDjO00m4PE1 + S+YsZoGw7rGmmj+KS4qv2T26FEHtUI+F31RC1FPohLsQ22Jbn1ORipsCgYEAyrYB + J2Ncf2DlX1C0GfxyUHQOTNl0V5gpGvpbZ0WmWksumYz2kSGOAJkxuDKd9mKVlAcz + czmN+OOetuHTNqds2JJKKJy6hJbgCdd9aho3dId5Xs4oh4YwuFQiG8R/bJZfTlXo + 99Qr02L7MmDWYLmrR3BA/93UPeorHPtjqSaYU40CgYEAtmGfWwokIglaSDVVqQVs + 3YwBqmcrla5TpkMLvLRZ2/fktqfL4Xod9iKu+Klajv9ZKTfFkXWno2HHL7FSD/Yc + hWwqnV5oDIXuDnlQOse/SeERb+IbD5iUfePpoJQgbrCQlwiB0TNGwOojR2SFMczf + Ai4aLlQLx5dSND9K9Y7HS+8CgYEAixlHQ2r4LuQjoTs0ytwi6TgqE+vn3K+qDTwc + eoods7oBWRaUn1RCKAD3UClToZ1WfMRQNtIYrOAsqdveXpOWqioAP0wE5TTOuZIo + GiWxRgIsc7TNtOmNBv+chCdbNP0emxdyjJUIGb7DFnfCw47EjHnn8Guc13uXaATN + B2ZXgoUCgYAGa13P0ggUf5BMJpBd8S08jKRyvZb1CDXcUCuGtk2yEx45ern9U5WY + zJ13E5z9MKKO8nkGBqrRfjJa8Xhxk4HKNFuzHEet5lvNE7IKCF4YQRb0ZBhnb/78 + +4ZKjFki1RrWRNSw9TdvrK6qaDKgTtCTtfRVXAYQXUgq7lSFOTtL3A== + -----END RSA PRIVATE KEY----- + DOC + end + let(:valid_cert_but_indented) do + valid_cert.gsub(%r{^}, ' ') + end + + let(:valid_key_but_indented) do + valid_key.gsub(%r{^}, ' ') + 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 + + let(:bad_key) do + 'bar' + end + + context 'with function signature validation' 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, 1, 2, 3).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + end + + context 'with valid input' do + describe 'valid certificate and key' do + it { is_expected.to run.with_params(valid_cert, valid_key) } + end + end + + context 'with bad input' do + 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, %r{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, %r{Not a valid RSA key}) } + end + + describe 'valid certificate, bad key' do + it { is_expected.to run.with_params(valid_cert, bad_key).and_raise_error(Puppet::ParseError, %r{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, %r{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, %r{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, %r{Not a valid x509 certificate}) } + end + + describe 'validate certificate and key; certficate not signed by key' do + it { is_expected.to run.with_params(valid_cert, another_valid_key).and_raise_error(Puppet::ParseError, %r{Certificate signature does not match supplied key}) } + end + + describe 'valid cert and key but arguments in wrong order' do + it { is_expected.to run.with_params(valid_key, valid_cert).and_raise_error(Puppet::ParseError, %r{Not a valid x509 certificate}) } + end + + describe 'non-string arguments' 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, 1).and_raise_error(Puppet::ParseError, %r{is not a string}) } + it { is_expected.to run.with_params(true, true).and_raise_error(Puppet::ParseError, %r{is not a string}) } + it { is_expected.to run.with_params('foo', {}).and_raise_error(Puppet::ParseError, %r{is not a string}) } + it { is_expected.to run.with_params(1, 'bar').and_raise_error(Puppet::ParseError, %r{is not a string}) } + it { is_expected.to run.with_params('baz', true).and_raise_error(Puppet::ParseError, %r{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[0..start_pos] + string[end_pos..] + end +end diff --git a/spec/functions/values_at_spec.rb b/spec/functions/values_at_spec.rb new file mode 100644 index 000000000..14e15e1c5 --- /dev/null +++ b/spec/functions/values_at_spec.rb @@ -0,0 +1,59 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'values_at' do + describe 'signature validation' 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([]).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + + it { + pending('Current implementation ignores parameters after the first two.') + 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) } + 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) } + it { is_expected.to run.with_params(1, 1).and_raise_error(Puppet::ParseError, %r{Requires array}i) } + it { is_expected.to run.with_params([0, 1, 2], 'two').and_raise_error(Puppet::ParseError, %r{Unknown format of given index}) } + it { is_expected.to run.with_params([0, 1, 2], []).and_raise_error(Puppet::ParseError, %r{provide at least one positive index}) } + it { is_expected.to run.with_params([0, 1, 2], '-1-1').and_raise_error(Puppet::ParseError, %r{Unknown format of given index}) } + it { is_expected.to run.with_params([0, 1, 2], '2-1').and_raise_error(Puppet::ParseError, %r{Stop index in given indices range is smaller than the start index}) } + end + + context 'when requesting a single item' do + it { is_expected.to run.with_params([0, 1, 2], -1).and_raise_error(Puppet::ParseError, %r{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, %r{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, %r{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, %r{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') + expect(subject).to run.with_params([0, 1, 2], '0...3').and_return([0, 1, 2]) + } + end + end +end diff --git a/spec/functions/xml_encode_spec.rb b/spec/functions/xml_encode_spec.rb new file mode 100644 index 000000000..18a20a0c0 --- /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 + expect(subject).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 diff --git a/spec/functions/zip_spec.rb b/spec/functions/zip_spec.rb new file mode 100644 index 000000000..f3e576435 --- /dev/null +++ b/spec/functions/zip_spec.rb @@ -0,0 +1,27 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'zip' 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([]).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } + + it { + pending('Current implementation ignores parameters after the third.') + 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([]) } + 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([['ầ', 'đ'], ['ь', 'ề'], ['ć', 'ƒ']]) } + it { is_expected.to run.with_params(['ペ', '含', '値'], ['ッ', '文', 'イ']).and_return([['ペ', 'ッ'], ['含', '文'], ['値', 'イ']]) } + end +end 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 index 1a1111799..beb36bff1 --- a/spec/monkey_patches/alias_should_to_must.rb +++ b/spec/monkey_patches/alias_should_to_must.rb @@ -1,8 +1,10 @@ -require 'rspec' +# frozen_string_literal: true +require 'rspec' +# class Object 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 old mode 100755 new mode 100644 index f3a1abf40..91eca2f60 --- a/spec/monkey_patches/publicize_methods.rb +++ b/spec/monkey_patches/publicize_methods.rb @@ -1,10 +1,12 @@ +# frozen_string_literal: true + # 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.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 931d35c84..ae7c1f681 100644 --- a/spec/spec_helper.rb +++ b/spec/spec_helper.rb @@ -1,28 +1,75 @@ -dir = File.expand_path(File.dirname(__FILE__)) -$LOAD_PATH.unshift File.join(dir, 'lib') +# frozen_string_literal: true -# Don't want puppet getting the command line arguments for rake or autotest -ARGV.clear - -require 'puppet' -require 'facter' -require 'mocha' -gem 'rspec', '>=2.0.0' -require 'rspec/expectations' +RSpec.configure do |c| + c.mock_with :rspec +end require 'puppetlabs_spec_helper/module_spec_helper' +require 'rspec-puppet-facts' + +require 'spec_helper_local' if File.file?(File.join(File.dirname(__FILE__), 'spec_helper_local.rb')) + +include RspecPuppetFacts + +default_facts = { + puppetversion: Puppet.version, + facterversion: Facter.version, +} + +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')), +] + +default_fact_files.each do |f| + next unless File.exist?(f) && File.readable?(f) && File.size?(f) + + begin + 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 +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 - # facts being exercised with something like - # Facter.collection.loader.load(:ipaddress) - Facter::Util::Loader.any_instance.stubs(:load_all) - Facter.clear - Facter.clear_messages +# read default_facts and merge them over what is provided by facterdb +default_facts.each do |fact, value| + add_custom_fact fact, value, merge_facts: true +end + +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 + Puppet.settings[:strict_variables] = true + end + c.filter_run_excluding(bolt: true) unless ENV['GEM_BOLT'] + 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 +# @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) + last_module.const_get(next_module, false) + end +end + +# 'spec_overrides' from sync.yml will appear below this line diff --git a/spec/spec_helper_acceptance.rb b/spec/spec_helper_acceptance.rb new file mode 100644 index 000000000..4ac8d7e0f --- /dev/null +++ b/spec/spec_helper_acceptance.rb @@ -0,0 +1,6 @@ +# frozen_string_literal: true + +require 'puppet_litmus' +require 'spec_helper_acceptance_local' if File.file?(File.join(File.dirname(__FILE__), 'spec_helper_acceptance_local.rb')) + +PuppetLitmus.configure! diff --git a/spec/spec_helper_local.rb b/spec/spec_helper_local.rb new file mode 100644 index 000000000..877294391 --- /dev/null +++ b/spec/spec_helper_local.rb @@ -0,0 +1,33 @@ +# frozen_string_literal: true + +# 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) + +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 diff --git a/spec/support/shared_data.rb b/spec/support/shared_data.rb new file mode 100644 index 000000000..e19f82488 --- /dev/null +++ b/spec/support/shared_data.rb @@ -0,0 +1,40 @@ +# frozen_string_literal: true + +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', + ].freeze + 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', + ].freeze +end diff --git a/spec/type_aliases/base32_spec.rb b/spec/type_aliases/base32_spec.rb new file mode 100644 index 000000000..b882058b0 --- /dev/null +++ b/spec/type_aliases/base32_spec.rb @@ -0,0 +1,42 @@ +# frozen_string_literal: true + +require 'spec_helper' + +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 + 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..0f3d2e3dc --- /dev/null +++ b/spec/type_aliases/base64_spec.rb @@ -0,0 +1,37 @@ +# frozen_string_literal: true + +require 'spec_helper' + +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 + end + end + end +end 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/spec/type_aliases/datasize_spec.rb b/spec/type_aliases/datasize_spec.rb new file mode 100644 index 000000000..0f469cc2b --- /dev/null +++ b/spec/type_aliases/datasize_spec.rb @@ -0,0 +1,40 @@ +# frozen_string_literal: true + +require 'spec_helper' + +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 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/email_spec.rb b/spec/type_aliases/email_spec.rb new file mode 100644 index 000000000..307de118a --- /dev/null +++ b/spec/type_aliases/email_spec.rb @@ -0,0 +1,73 @@ +# frozen_string_literal: true + +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', + '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| + describe value.inspect do + it { is_expected.not_to allow_value(value) } + end + end + end +end diff --git a/spec/type_aliases/ensure_package_spec.rb b/spec/type_aliases/ensure_package_spec.rb new file mode 100644 index 000000000..0eccb106a --- /dev/null +++ b/spec/type_aliases/ensure_package_spec.rb @@ -0,0 +1,40 @@ +# 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/spec/type_aliases/filemode_spec.rb b/spec/type_aliases/filemode_spec.rb new file mode 100644 index 000000000..8e96c3c6f --- /dev/null +++ b/spec/type_aliases/filemode_spec.rb @@ -0,0 +1,60 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'Stdlib::Filemode' do + describe 'valid modes' do + [ + '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 + 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', + + '=8,X', + 'x=r,a=wx', + ].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/filesource_spec.rb b/spec/type_aliases/filesource_spec.rb new file mode 100644 index 000000000..38e533ca8 --- /dev/null +++ b/spec/type_aliases/filesource_spec.rb @@ -0,0 +1,64 @@ +# frozen_string_literal: true + +require 'spec_helper' + +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 + end + end + end +end diff --git a/spec/type_aliases/fqdn_spec.rb b/spec/type_aliases/fqdn_spec.rb new file mode 100644 index 000000000..f7d526ee7 --- /dev/null +++ b/spec/type_aliases/fqdn_spec.rb @@ -0,0 +1,39 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'Stdlib::Fqdn' do + describe 'valid handling' do + [ + '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 + 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 + 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..6cfd3d94b --- /dev/null +++ b/spec/type_aliases/host_spec.rb @@ -0,0 +1,45 @@ +# frozen_string_literal: true + +require 'spec_helper' + +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', + '10.10.10.10.10', + ].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 diff --git a/spec/type_aliases/http__method_spec.rb b/spec/type_aliases/http__method_spec.rb new file mode 100644 index 000000000..838660f01 --- /dev/null +++ b/spec/type_aliases/http__method_spec.rb @@ -0,0 +1,42 @@ +# frozen_string_literal: true + +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..384b284c4 --- /dev/null +++ b/spec/type_aliases/http__status_spec.rb @@ -0,0 +1,40 @@ +# frozen_string_literal: true + +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 new file mode 100644 index 000000000..2f5d53a2c --- /dev/null +++ b/spec/type_aliases/httpstatus_spec.rb @@ -0,0 +1,40 @@ +# frozen_string_literal: true + +require 'spec_helper' + +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 diff --git a/spec/type_aliases/httpsurl_spec.rb b/spec/type_aliases/httpsurl_spec.rb new file mode 100644 index 000000000..e1ac0278a --- /dev/null +++ b/spec/type_aliases/httpsurl_spec.rb @@ -0,0 +1,38 @@ +# frozen_string_literal: true + +require 'spec_helper' + +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 + end + end + end +end diff --git a/spec/type_aliases/httpurl_spec.rb b/spec/type_aliases/httpurl_spec.rb new file mode 100644 index 000000000..97c18a961 --- /dev/null +++ b/spec/type_aliases/httpurl_spec.rb @@ -0,0 +1,39 @@ +# frozen_string_literal: true + +require 'spec_helper' + +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 + end + end + end +end 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..a87e14996 --- /dev/null +++ b/spec/type_aliases/ip_address_nosubnet_spec.rb @@ -0,0 +1,44 @@ +# frozen_string_literal: true + +require 'spec_helper' + +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 diff --git a/spec/type_aliases/ip_address_spec.rb b/spec/type_aliases/ip_address_spec.rb new file mode 100644 index 000000000..08d9917b5 --- /dev/null +++ b/spec/type_aliases/ip_address_spec.rb @@ -0,0 +1,44 @@ +# frozen_string_literal: true + +require 'spec_helper' + +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 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..f4e750373 --- /dev/null +++ b/spec/type_aliases/ip_address_v4_nosubnet_spec.rb @@ -0,0 +1,30 @@ +# frozen_string_literal: true + +require 'spec_helper' + +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 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..8036f0cab --- /dev/null +++ b/spec/type_aliases/ip_address_v4_spec.rb @@ -0,0 +1,30 @@ +# frozen_string_literal: true + +require 'spec_helper' + +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 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..74cfdb7bc --- /dev/null +++ b/spec/type_aliases/ip_address_v6_alternative_spec.rb @@ -0,0 +1,28 @@ +# frozen_string_literal: true + +require 'spec_helper' + +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 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..246fe54b1 --- /dev/null +++ b/spec/type_aliases/ip_address_v6_cidr_spec.rb @@ -0,0 +1,32 @@ +# frozen_string_literal: true + +require 'spec_helper' + +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 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..1ddd9c4d5 --- /dev/null +++ b/spec/type_aliases/ip_address_v6_compressed_spec.rb @@ -0,0 +1,31 @@ +# frozen_string_literal: true + +require 'spec_helper' + +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 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..70aac9cef --- /dev/null +++ b/spec/type_aliases/ip_address_v6_full_spec.rb @@ -0,0 +1,28 @@ +# frozen_string_literal: true + +require 'spec_helper' + +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 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..4a01b7f51 --- /dev/null +++ b/spec/type_aliases/ip_address_v6_nosubnet_alternative_spec.rb @@ -0,0 +1,28 @@ +# frozen_string_literal: true + +require 'spec_helper' + +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 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..b6b7fa89d --- /dev/null +++ b/spec/type_aliases/ip_address_v6_nosubnet_compressed_spec.rb @@ -0,0 +1,31 @@ +# frozen_string_literal: true + +require 'spec_helper' + +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 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..8272d4d21 --- /dev/null +++ b/spec/type_aliases/ip_address_v6_nosubnet_full_spec.rb @@ -0,0 +1,28 @@ +# frozen_string_literal: true + +require 'spec_helper' + +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 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..36e9ef7e5 --- /dev/null +++ b/spec/type_aliases/ip_address_v6_spec.rb @@ -0,0 +1,32 @@ +# frozen_string_literal: true + +require 'spec_helper' + +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 diff --git a/spec/type_aliases/mac_spec.rb b/spec/type_aliases/mac_spec.rb new file mode 100644 index 000000000..492b07cd0 --- /dev/null +++ b/spec/type_aliases/mac_spec.rb @@ -0,0 +1,40 @@ +# frozen_string_literal: true + +require 'spec_helper' + +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 diff --git a/spec/type_aliases/objectstore_gsuri_spec.rb b/spec/type_aliases/objectstore_gsuri_spec.rb new file mode 100644 index 000000000..d75812e15 --- /dev/null +++ b/spec/type_aliases/objectstore_gsuri_spec.rb @@ -0,0 +1,35 @@ +# frozen_string_literal: true + +require 'spec_helper' + +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 + 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..4c774ed9a --- /dev/null +++ b/spec/type_aliases/objectstore_s3uri_spec.rb @@ -0,0 +1,35 @@ +# frozen_string_literal: true + +require 'spec_helper' + +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 + 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..f5780e65b --- /dev/null +++ b/spec/type_aliases/objectstore_spec.rb @@ -0,0 +1,34 @@ +# frozen_string_literal: true + +require 'spec_helper' + +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 diff --git a/spec/type_aliases/port__dynamic_spec.rb b/spec/type_aliases/port__dynamic_spec.rb new file mode 100644 index 000000000..69cb0190b --- /dev/null +++ b/spec/type_aliases/port__dynamic_spec.rb @@ -0,0 +1,43 @@ +# frozen_string_literal: true + +require 'spec_helper' + +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 diff --git a/spec/type_aliases/port__privileged_spec.rb b/spec/type_aliases/port__privileged_spec.rb new file mode 100644 index 000000000..c09bd2bc5 --- /dev/null +++ b/spec/type_aliases/port__privileged_spec.rb @@ -0,0 +1,39 @@ +# frozen_string_literal: true + +require 'spec_helper' + +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 diff --git a/spec/type_aliases/port__unprivileged_spec.rb b/spec/type_aliases/port__unprivileged_spec.rb new file mode 100644 index 000000000..16c634639 --- /dev/null +++ b/spec/type_aliases/port__unprivileged_spec.rb @@ -0,0 +1,40 @@ +# frozen_string_literal: true + +require 'spec_helper' + +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 diff --git a/spec/type_aliases/port__user_spec.rb b/spec/type_aliases/port__user_spec.rb new file mode 100644 index 000000000..a86ff8e47 --- /dev/null +++ b/spec/type_aliases/port__user_spec.rb @@ -0,0 +1,41 @@ +# frozen_string_literal: true + +require 'spec_helper' + +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 diff --git a/spec/type_aliases/port_spec.rb b/spec/type_aliases/port_spec.rb new file mode 100644 index 000000000..3ed3a8d1f --- /dev/null +++ b/spec/type_aliases/port_spec.rb @@ -0,0 +1,39 @@ +# frozen_string_literal: true + +require 'spec_helper' + +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 diff --git a/spec/type_aliases/unixpath_spec.rb b/spec/type_aliases/unixpath_spec.rb new file mode 100644 index 000000000..2ec64159e --- /dev/null +++ b/spec/type_aliases/unixpath_spec.rb @@ -0,0 +1,39 @@ +# frozen_string_literal: true + +require 'spec_helper' + +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 + end + end + end +end diff --git a/spec/type_aliases/windowspath_spec.rb b/spec/type_aliases/windowspath_spec.rb new file mode 100644 index 000000000..f8bd1cc24 --- /dev/null +++ b/spec/type_aliases/windowspath_spec.rb @@ -0,0 +1,39 @@ +# frozen_string_literal: true + +require 'spec_helper' + +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 + end + end + end +end diff --git a/spec/type_aliases/yes_no_spec.rb b/spec/type_aliases/yes_no_spec.rb new file mode 100644 index 000000000..4adbb0ff5 --- /dev/null +++ b/spec/type_aliases/yes_no_spec.rb @@ -0,0 +1,44 @@ +# frozen_string_literal: true + +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/spec/unit/facter/package_provider_spec.rb b/spec/unit/facter/package_provider_spec.rb new file mode 100644 index 000000000..3e75c2870 --- /dev/null +++ b/spec/unit/facter/package_provider_spec.rb @@ -0,0 +1,45 @@ +# frozen_string_literal: true + +require 'spec_helper' +require 'puppet/type' +require 'puppet/type/package' + +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 + before :each do + allow(Facter).to receive(:value).and_return(puppetversion) + end + + context 'when darwin' do + it 'returns pkgdmg' do + provider = Puppet::Type.type(:package).provider(:pkgdmg) + allow(Puppet::Type.type(:package)).to receive(:defaultprovider).and_return(provider) + + expect(Facter.fact(:package_provider).value).to eq('pkgdmg') + end + end + + context 'when centos 7' do + it 'returns yum' do + provider = Puppet::Type.type(:package).provider(:yum) + allow(Puppet::Type.type(:package)).to receive(:defaultprovider).and_return(provider) + + expect(Facter.fact(:package_provider).value).to eq('yum') + end + end + + context 'when ubuntu' do + it 'returns apt' do + provider = Puppet::Type.type(:package).provider(:apt) + allow(Puppet::Type.type(:package)).to receive(:defaultprovider).and_return(provider) + + expect(Facter.fact(:package_provider).value).to eq('apt') + end + end + end + end +end 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 diff --git a/spec/unit/facter/pe_version_spec.rb b/spec/unit/facter/pe_version_spec.rb index 931c6d4b0..56b3dafe1 100644 --- a/spec/unit/facter/pe_version_spec.rb +++ b/spec/unit/facter/pe_version_spec.rb @@ -1,76 +1,81 @@ -#!/usr/bin/env rspec +# frozen_string_literal: true 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) +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) + end + + 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 'when PE is installed' do + ['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) + 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(".") + (major, minor, patch) = version.split('.') - it "Should return true" do - Facter.fact(:is_pe).value.should == true + it 'returns true' do + expect(Facter.fact(:is_pe).value).to be(true) end - it "Should have a version of #{version}" do - Facter.fact(:pe_version).value.should == version + 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 - Facter.fact(:pe_major_version).value.should == major + 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 - Facter.fact(:pe_minor_version).value.should == minor + 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 - Facter.fact(:pe_patch_version).value.should == patch + it "has a patch version of #{patch}" do + expect(Facter.fact(:pe_patch_version).value).to eq(patch) end end 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") + allow(Facter.fact(:puppetversion)).to receive(:value).and_return('2.7.19') end - it "is_pe is false" do - Facter.fact(:is_pe).value.should == false + it 'is_pe is false' do + expect(Facter.fact(:is_pe).value).to be(false) end - it "pe_version is nil" do - Facter.fact(:pe_version).value.should be_nil + it 'pe_version is nil' do + 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 + 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 - Facter.fact(:pe_minor_version).value.should be_nil + 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 - Facter.fact(:pe_patch_version).value.should be_nil + 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 ce80684ca..e1c97a30e 100644 --- a/spec/unit/facter/root_home_spec.rb +++ b/spec/unit/facter/root_home_spec.rb @@ -1,40 +1,21 @@ +# frozen_string_literal: true + require 'spec_helper' require 'facter/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) { "/" } +describe 'root_home', type: :fact do + subject { Facter.fact(:root_home) } - 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 - end - end - context "linux" do - let(:root_ent) { "root:x:0:0:root:/root:/bin/bash" } - let(:expected_root_home) { "/root" } + before(:each) { Facter.clear } + after(:each) { Facter.clear } - 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 - end + context 'when Windows', if: Facter.value(:kernel) == 'Windows' do + it { expect(subject.value).to be_nil } 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) - end - it "should be nil on windows" do - Facter::Util::RootHome.get_root_home.should be_nil - end + context 'when non-Windows', if: Facter.value(:kernel) != 'Windows' do + let(:expected) { (Facter.value(:kernel) == 'Darwin') ? '/var/root' : '/root' } + + it { expect(subject.value).to eq(expected) } 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..4d7d4e104 --- /dev/null +++ b/spec/unit/facter/service_provider_spec.rb @@ -0,0 +1,37 @@ +# frozen_string_literal: true + +require 'spec_helper' +require 'puppet/type' +require 'puppet/type/service' + +describe 'service_provider', type: :fact do + before(:each) { Facter.clear } + after(:each) { Facter.clear } + + context 'when macosx' do + it 'returns launchd' do + provider = Puppet::Type.type(:service).provider(:launchd) + allow(Puppet::Type.type(:service)).to receive(:defaultprovider).and_return(provider) + + expect(Facter.fact(:service_provider).value).to eq('launchd') + end + end + + context 'when systemd' do + it 'returns systemd' do + provider = Puppet::Type.type(:service).provider(:systemd) + allow(Puppet::Type.type(:service)).to receive(:defaultprovider).and_return(provider) + + expect(Facter.fact(:service_provider).value).to eq('systemd') + end + end + + context 'when redhat' do + it 'returns redhat' do + provider = Puppet::Type.type(:service).provider(:redhat) + allow(Puppet::Type.type(:service)).to receive(:defaultprovider).and_return(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 c3ce6ea07..13d032f51 100644 --- a/spec/unit/facter/util/puppet_settings_spec.rb +++ b/spec/unit/facter/util/puppet_settings_spec.rb @@ -1,34 +1,40 @@ +# frozen_string_literal: true + require 'spec_helper' 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) + allow(Module).to receive(:const_get).with(:Puppet).and_raise(NameError) end - it 'should be nil' do - subject.with_puppet { Puppet[:vardir] }.should be_nil + it 'is nil' do + 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 + + it 'does not yield to the block' do + expect(Puppet).not_to receive(:[]) + expect(subject.with_puppet { Puppet[:vardir] }).to be_nil end end - context "With Puppet loaded" do + + context 'with Puppet loaded' do + # module Puppet module Puppet; end - let(:vardir) { "/var/lib/puppet" } + let(:vardir) { '/var/lib/puppet' } before :each do - Puppet.expects(:[]).with(:vardir).returns vardir + allow(Puppet).to receive(:[]).with(:vardir).and_return(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 - subject.with_puppet { Puppet[:vardir] }.should eq vardir + + it 'returns the nodes vardir' do + expect(subject.with_puppet { Puppet[:vardir] }).to eq vardir end end end diff --git a/spec/unit/puppet/parser/functions/abs_spec.rb b/spec/unit/puppet/parser/functions/abs_spec.rb deleted file mode 100755 index c0b42970c..000000000 --- a/spec/unit/puppet/parser/functions/abs_spec.rb +++ /dev/null @@ -1,25 +0,0 @@ -#! /usr/bin/env ruby -S rspec - -require 'spec_helper' - -describe "the abs function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - Puppet::Parser::Functions.function("abs").should == "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)) - end - - it "should convert a negative number into a positive" do - result = scope.function_abs(["-34"]) - result.should(eq(34)) - end - - it "should do nothing with a positive number" do - result = scope.function_abs(["5678"]) - result.should(eq(5678)) - end -end diff --git a/spec/unit/puppet/parser/functions/any2array_spec.rb b/spec/unit/puppet/parser/functions/any2array_spec.rb deleted file mode 100644 index b266e84f4..000000000 --- a/spec/unit/puppet/parser/functions/any2array_spec.rb +++ /dev/null @@ -1,55 +0,0 @@ -#! /usr/bin/env ruby -S rspec -require 'spec_helper' - -describe "the any2array function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - Puppet::Parser::Functions.function("any2array").should == "function_any2array" - end - - it "should return an empty array if there is less than 1 argument" do - result = scope.function_any2array([]) - result.should(eq([])) - end - - it "should convert boolean true to [ true ] " do - result = scope.function_any2array([true]) - result.should(eq([true])) - end - - it "should convert one object to [object]" do - result = scope.function_any2array(['one']) - result.should(eq(['one'])) - end - - it "should convert multiple objects to [objects]" do - result = scope.function_any2array(['one', 'two']) - result.should(eq(['one', 'two'])) - end - - it "should return empty array it was called with" do - result = scope.function_any2array([[]]) - result.should(eq([])) - end - - it "should return one-member array it was called with" do - result = scope.function_any2array([['string']]) - result.should(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'])) - end - - it "should return members of a hash it was called with" do - result = scope.function_any2array([{ 'key' => 'value' }]) - result.should(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([])) - end -end diff --git a/spec/unit/puppet/parser/functions/base64_spec.rb b/spec/unit/puppet/parser/functions/base64_spec.rb deleted file mode 100755 index 5faa5e66c..000000000 --- a/spec/unit/puppet/parser/functions/base64_spec.rb +++ /dev/null @@ -1,34 +0,0 @@ -#! /usr/bin/env ruby -S rspec - -require 'spec_helper' - -describe "the base64 function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - Puppet::Parser::Functions.function("base64").should == "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']) - result.should =~ /\AdGhlc3RyaW5n\n\Z/ - end - it "should decode a base64 encoded string" do - result = scope.function_base64(["decode",'dGhlc3RyaW5n']) - result.should == 'thestring' - end -end diff --git a/spec/unit/puppet/parser/functions/bool2num_spec.rb b/spec/unit/puppet/parser/functions/bool2num_spec.rb deleted file mode 100755 index 518ac85ec..000000000 --- a/spec/unit/puppet/parser/functions/bool2num_spec.rb +++ /dev/null @@ -1,24 +0,0 @@ -#! /usr/bin/env ruby -S rspec -require 'spec_helper' - -describe "the bool2num function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - Puppet::Parser::Functions.function("bool2num").should == "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)) - 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]) - result.should(eq(0)) - end -end diff --git a/spec/unit/puppet/parser/functions/capitalize_spec.rb b/spec/unit/puppet/parser/functions/capitalize_spec.rb deleted file mode 100755 index 69c9758f2..000000000 --- a/spec/unit/puppet/parser/functions/capitalize_spec.rb +++ /dev/null @@ -1,19 +0,0 @@ -#! /usr/bin/env ruby -S rspec -require 'spec_helper' - -describe "the capitalize function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - Puppet::Parser::Functions.function("capitalize").should == "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)) - end - - it "should capitalize the beginning of a string" do - result = scope.function_capitalize(["abc"]) - result.should(eq("Abc")) - end -end diff --git a/spec/unit/puppet/parser/functions/chomp_spec.rb b/spec/unit/puppet/parser/functions/chomp_spec.rb deleted file mode 100755 index e425365fc..000000000 --- a/spec/unit/puppet/parser/functions/chomp_spec.rb +++ /dev/null @@ -1,19 +0,0 @@ -#! /usr/bin/env ruby -S rspec -require 'spec_helper' - -describe "the chomp function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - Puppet::Parser::Functions.function("chomp").should == "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)) - end - - it "should chomp the end of a string" do - result = scope.function_chomp(["abc\n"]) - result.should(eq("abc")) - end -end diff --git a/spec/unit/puppet/parser/functions/chop_spec.rb b/spec/unit/puppet/parser/functions/chop_spec.rb deleted file mode 100755 index 9e466de4b..000000000 --- a/spec/unit/puppet/parser/functions/chop_spec.rb +++ /dev/null @@ -1,19 +0,0 @@ -#! /usr/bin/env ruby -S rspec -require 'spec_helper' - -describe "the chop function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - Puppet::Parser::Functions.function("chop").should == "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)) - end - - it "should chop the end of a string" do - result = scope.function_chop(["asdf\n"]) - result.should(eq("asdf")) - end -end diff --git a/spec/unit/puppet/parser/functions/concat_spec.rb b/spec/unit/puppet/parser/functions/concat_spec.rb deleted file mode 100644 index 123188bd4..000000000 --- a/spec/unit/puppet/parser/functions/concat_spec.rb +++ /dev/null @@ -1,15 +0,0 @@ -#! /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 there is less than 1 arguments" do - lambda { scope.function_concat([]) }.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 -end diff --git a/spec/unit/puppet/parser/functions/count_spec.rb b/spec/unit/puppet/parser/functions/count_spec.rb deleted file mode 100644 index 2453815c2..000000000 --- a/spec/unit/puppet/parser/functions/count_spec.rb +++ /dev/null @@ -1,31 +0,0 @@ -#! /usr/bin/env ruby -S rspec - -require 'spec_helper' - -describe "the count function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - Puppet::Parser::Functions.function("count").should == "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)) - end - - it "should be able to count arrays" do - scope.function_count([["1","2","3"]]).should(eq(3)) - end - - it "should be able to count matching elements in arrays" do - scope.function_count([["1", "2", "2"], "2"]).should(eq(2)) - end - - it "should not count nil or empty strings" do - scope.function_count([["foo","bar",nil,""]]).should(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 -end diff --git a/spec/unit/puppet/parser/functions/deep_merge_spec.rb b/spec/unit/puppet/parser/functions/deep_merge_spec.rb deleted file mode 100644 index fffb7f798..000000000 --- a/spec/unit/puppet/parser/functions/deep_merge_spec.rb +++ /dev/null @@ -1,77 +0,0 @@ -#! /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 - pending("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 - pending("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 - 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(Puppet::ParseError, /unexpected argument type String/) - 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'}]) - new_hash['one'].should == '1' - new_hash['two'].should == '2' - new_hash['three'].should == '2' - end - - it 'should deep_merge multiple hashes' do - hash = scope.function_deep_merge([{'one' => 1}, {'one' => '2'}, {'one' => '3'}]) - hash['one'].should == '3' - end - - it 'should accept empty hashes' do - scope.function_deep_merge([{},{},{}]).should == {} - 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 } - 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 } - 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 } - 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 } - end - end -end diff --git a/spec/unit/puppet/parser/functions/delete_at_spec.rb b/spec/unit/puppet/parser/functions/delete_at_spec.rb deleted file mode 100755 index cfc0a2963..000000000 --- a/spec/unit/puppet/parser/functions/delete_at_spec.rb +++ /dev/null @@ -1,25 +0,0 @@ -#! /usr/bin/env ruby -S rspec -require 'spec_helper' - -describe "the delete_at function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - Puppet::Parser::Functions.function("delete_at").should == "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)) - 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'])) - 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'])) - end -end diff --git a/spec/unit/puppet/parser/functions/delete_spec.rb b/spec/unit/puppet/parser/functions/delete_spec.rb deleted file mode 100755 index 06238f152..000000000 --- a/spec/unit/puppet/parser/functions/delete_spec.rb +++ /dev/null @@ -1,56 +0,0 @@ -#! /usr/bin/env ruby -S rspec -require 'spec_helper' - -describe "the delete function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - Puppet::Parser::Functions.function("delete").should == "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)) - 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)) - 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)) - 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'])) - end - - it "should delete all instances of a substring from a string" do - result = scope.function_delete(['foobarbabarz','bar']) - result.should(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 })) - 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'])) - 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')) - 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 })) - end - -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 deleted file mode 100644 index 404aedaf3..000000000 --- a/spec/unit/puppet/parser/functions/delete_undef_values_spec.rb +++ /dev/null @@ -1,41 +0,0 @@ -#! /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 - Puppet::Parser::Functions.function("delete_undef_values").should == "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)) - 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)) - 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'])) - 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'})) - 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'])) - 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' })) - end -end diff --git a/spec/unit/puppet/parser/functions/delete_values_spec.rb b/spec/unit/puppet/parser/functions/delete_values_spec.rb deleted file mode 100644 index 180cc3021..000000000 --- a/spec/unit/puppet/parser/functions/delete_values_spec.rb +++ /dev/null @@ -1,36 +0,0 @@ -#! /usr/bin/env ruby -S rspec -require 'spec_helper' - -describe "the delete_values function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - Puppet::Parser::Functions.function("delete_values").should == "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)) - 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)) - 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)) - 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' })) - 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 })) - end - -end diff --git a/spec/unit/puppet/parser/functions/difference_spec.rb b/spec/unit/puppet/parser/functions/difference_spec.rb deleted file mode 100644 index 9feff0918..000000000 --- a/spec/unit/puppet/parser/functions/difference_spec.rb +++ /dev/null @@ -1,19 +0,0 @@ -#! /usr/bin/env ruby -S rspec -require 'spec_helper' - -describe "the difference function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - Puppet::Parser::Functions.function("difference").should == "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) ) - end - - it "should return the difference between two arrays" do - result = scope.function_difference([["a","b","c"],["b","c","d"]]) - result.should(eq(["a"])) - end -end diff --git a/spec/unit/puppet/parser/functions/dirname_spec.rb b/spec/unit/puppet/parser/functions/dirname_spec.rb deleted file mode 100755 index fb3b4feca..000000000 --- a/spec/unit/puppet/parser/functions/dirname_spec.rb +++ /dev/null @@ -1,24 +0,0 @@ -#! /usr/bin/env ruby -S rspec -require 'spec_helper' - -describe "the dirname function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - Puppet::Parser::Functions.function("dirname").should == "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)) - 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')) - 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')) - end -end diff --git a/spec/unit/puppet/parser/functions/downcase_spec.rb b/spec/unit/puppet/parser/functions/downcase_spec.rb deleted file mode 100755 index acef1f05d..000000000 --- a/spec/unit/puppet/parser/functions/downcase_spec.rb +++ /dev/null @@ -1,24 +0,0 @@ -#! /usr/bin/env ruby -S rspec -require 'spec_helper' - -describe "the downcase function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - Puppet::Parser::Functions.function("downcase").should == "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)) - end - - it "should downcase a string" do - result = scope.function_downcase(["ASFD"]) - result.should(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")) - end -end diff --git a/spec/unit/puppet/parser/functions/empty_spec.rb b/spec/unit/puppet/parser/functions/empty_spec.rb deleted file mode 100755 index 774587522..000000000 --- a/spec/unit/puppet/parser/functions/empty_spec.rb +++ /dev/null @@ -1,23 +0,0 @@ -#! /usr/bin/env ruby -S rspec -require 'spec_helper' - -describe "the empty function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - it "should exist" do - Puppet::Parser::Functions.function("empty").should == "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)) - end - - it "should return a true for an empty string" do - result = scope.function_empty(['']) - result.should(eq(true)) - end - - it "should return a false for a non-empty string" do - result = scope.function_empty(['asdf']) - result.should(eq(false)) - 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..280b49603 --- /dev/null +++ b/spec/unit/puppet/parser/functions/enclose_ipv6_spec.rb @@ -0,0 +1,72 @@ +# frozen_string_literal: true + +require 'spec_helper' + +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') + end + + it 'raises a ParseError if there is less than 1 arguments' do + expect { scope.function_enclose_ipv6([]) }.to(raise_error(Puppet::ParseError)) + end + + it 'raises a ParseError if there is more than 1 arguments' do + expect { scope.function_enclose_ipv6(['argument1', 'argument2']) }.to(raise_error(Puppet::ParseError)) + end + + it 'raises a ParseError when given garbage' do + expect { scope.function_enclose_ipv6(['garbage']) }.to(raise_error(Puppet::ParseError)) + end + + 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 '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 'does not raise a ParseError when given * as ip strint g' do + expect { scope.function_enclose_ipv6(['*']) }.not_to raise_error + end + + 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 '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 '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 '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 'raises a ParseError when given a wrong ipv6 address' do + expect { scope.function_enclose_ipv6(['fe80:::1']) }.to(raise_error(Puppet::ParseError)) + end + + 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 'embraces a single ipv6 adresse' do + result = scope.function_enclose_ipv6(['fe80::1']) + expect(result).to(eq(['[fe80::1]'])) + end + + 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 +end diff --git a/spec/unit/puppet/parser/functions/flatten_spec.rb b/spec/unit/puppet/parser/functions/flatten_spec.rb deleted file mode 100755 index dba7a6bbd..000000000 --- a/spec/unit/puppet/parser/functions/flatten_spec.rb +++ /dev/null @@ -1,27 +0,0 @@ -#! /usr/bin/env ruby -S rspec -require 'spec_helper' - -describe "the flatten function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - it "should exist" do - Puppet::Parser::Functions.function("flatten").should == "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)) - end - - it "should raise a ParseError if there is more than 1 argument" do - lambda { scope.function_flatten([[], []]) }.should( 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"])) - 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"])) - end -end diff --git a/spec/unit/puppet/parser/functions/floor_spec.rb b/spec/unit/puppet/parser/functions/floor_spec.rb deleted file mode 100644 index dbc8c7735..000000000 --- a/spec/unit/puppet/parser/functions/floor_spec.rb +++ /dev/null @@ -1,39 +0,0 @@ -#! /usr/bin/env ruby -S rspec - -require 'spec_helper' - -describe "the floor function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - Puppet::Parser::Functions.function("floor").should == "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/)) - 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/)) - 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/)) - 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)) - end - - it "should return the input when an integer is passed" do - result = scope.function_floor([7]) - result.should(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)) - end -end - diff --git a/spec/unit/puppet/parser/functions/fqdn_rotate_spec.rb b/spec/unit/puppet/parser/functions/fqdn_rotate_spec.rb deleted file mode 100644 index 257772335..000000000 --- a/spec/unit/puppet/parser/functions/fqdn_rotate_spec.rb +++ /dev/null @@ -1,33 +0,0 @@ -#! /usr/bin/env ruby -S rspec -require 'spec_helper' - -describe "the fqdn_rotate function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - Puppet::Parser::Functions.function("fqdn_rotate").should == "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)) - 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)) - 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"])) - 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"]) - val1.should_not eql(val2) - end -end diff --git a/spec/unit/puppet/parser/functions/get_module_path_spec.rb b/spec/unit/puppet/parser/functions/get_module_path_spec.rb deleted file mode 100644 index 486bef6f2..000000000 --- a/spec/unit/puppet/parser/functions/get_module_path_spec.rb +++ /dev/null @@ -1,46 +0,0 @@ -#! /usr/bin/env ruby -S rspec -require 'spec_helper' - -describe Puppet::Parser::Functions.function(:get_module_path) do - Internals = PuppetlabsSpec::PuppetInternals - class StubModule - attr_reader :path - def initialize(path) - @path = 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) - scope.function_get_module_path(['foo']).should == 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 - end - it 'should respect the environment' do - pending("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 - end - end -end diff --git a/spec/unit/puppet/parser/functions/getvar_spec.rb b/spec/unit/puppet/parser/functions/getvar_spec.rb deleted file mode 100644 index 5ff834ee7..000000000 --- a/spec/unit/puppet/parser/functions/getvar_spec.rb +++ /dev/null @@ -1,37 +0,0 @@ -#! /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 - - it "should not compile when no arguments are passed" do - pending("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 - - 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\./ - Puppet[:code] = '$foo = getvar("foo::bar", "baz")' - expect { - scope.compiler.compile - }.to raise_error(Puppet::ParseError, /wrong number of arguments/) - end - - it "should lookup variables in other namespaces" do - pending("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 - end - end -end diff --git a/spec/unit/puppet/parser/functions/grep_spec.rb b/spec/unit/puppet/parser/functions/grep_spec.rb deleted file mode 100755 index a93b84253..000000000 --- a/spec/unit/puppet/parser/functions/grep_spec.rb +++ /dev/null @@ -1,19 +0,0 @@ -#! /usr/bin/env ruby -S rspec -require 'spec_helper' - -describe "the grep function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - Puppet::Parser::Functions.function("grep").should == "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)) - end - - it "should grep contents from an array" do - result = scope.function_grep([["aaabbb","bbbccc","dddeee"], "bbb"]) - result.should(eq(["aaabbb","bbbccc"])) - end -end diff --git a/spec/unit/puppet/parser/functions/has_interface_with_spec.rb b/spec/unit/puppet/parser/functions/has_interface_with_spec.rb deleted file mode 100755 index c5264e4f3..000000000 --- a/spec/unit/puppet/parser/functions/has_interface_with_spec.rb +++ /dev/null @@ -1,64 +0,0 @@ -#!/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 - - # 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 - subject.call(['lo0']).should be_true - end - it 'should not have loopback (lo)' do - subject.call(['lo']).should be_false - end - 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 - subject.call(['lo']).should be_true - end - it 'should not have loopback (lo0)' do - subject.call(['lo0']).should be_false - end - it 'should have ipaddress with 127.0.0.1' do - subject.call(['ipaddress', '127.0.0.1']).should be_true - end - it 'should have ipaddress with 10.0.0.1' do - subject.call(['ipaddress', '10.0.0.1']).should be_true - end - it 'should not have ipaddress with 10.0.0.2' do - subject.call(['ipaddress', '10.0.0.2']).should be_false - end - it 'should have muppet named kermit' do - subject.call(['muppet', 'kermit']).should be_true - end - it 'should have muppet named mspiggy' do - subject.call(['muppet', 'mspiggy']).should be_true - end - it 'should not have muppet named bigbird' do - subject.call(['muppet', 'bigbird']).should be_false - end - end -end diff --git a/spec/unit/puppet/parser/functions/has_ip_address_spec.rb b/spec/unit/puppet/parser/functions/has_ip_address_spec.rb deleted file mode 100755 index 5a6846082..000000000 --- a/spec/unit/puppet/parser/functions/has_ip_address_spec.rb +++ /dev/null @@ -1,39 +0,0 @@ -#!/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 - - 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 - subject.call(['10.0.2.15']).should be_true - end - - it 'should have lookupback address (127.0.0.1)' do - subject.call(['127.0.0.1']).should be_true - end - - it 'should not have other address' do - subject.call(['192.1681.1.1']).should be_false - end - - it 'should not have "mspiggy" on an interface' do - subject.call(['mspiggy']).should be_false - end - end -end diff --git a/spec/unit/puppet/parser/functions/has_ip_network_spec.rb b/spec/unit/puppet/parser/functions/has_ip_network_spec.rb deleted file mode 100755 index c3a289e37..000000000 --- a/spec/unit/puppet/parser/functions/has_ip_network_spec.rb +++ /dev/null @@ -1,36 +0,0 @@ -#!/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 - - 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 - subject.call(['10.0.2.0']).should be_true - end - - it 'should have loopback network (127.0.0.0)' do - subject.call(['127.0.0.1']).should be_true - end - - it 'should not have other network' do - subject.call(['192.168.1.0']).should be_false - end - end -end - diff --git a/spec/unit/puppet/parser/functions/has_key_spec.rb b/spec/unit/puppet/parser/functions/has_key_spec.rb deleted file mode 100644 index 490daeae7..000000000 --- a/spec/unit/puppet/parser/functions/has_key_spec.rb +++ /dev/null @@ -1,42 +0,0 @@ -#! /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 - pending("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 - pending("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 - pending("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 - scope.function_has_key([{'one' => 1}, 'one']).should be_true - end - - it 'should detect existing keys' do - scope.function_has_key([{'one' => 1}, 'two']).should be_false - end - end -end diff --git a/spec/unit/puppet/parser/functions/hash_spec.rb b/spec/unit/puppet/parser/functions/hash_spec.rb deleted file mode 100644 index 7c91be907..000000000 --- a/spec/unit/puppet/parser/functions/hash_spec.rb +++ /dev/null @@ -1,19 +0,0 @@ -#! /usr/bin/env ruby -S rspec -require 'spec_helper' - -describe "the hash function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - Puppet::Parser::Functions.function("hash").should == "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)) - 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})) - end -end diff --git a/spec/unit/puppet/parser/functions/intersection_spec.rb b/spec/unit/puppet/parser/functions/intersection_spec.rb deleted file mode 100644 index fd44f7fe3..000000000 --- a/spec/unit/puppet/parser/functions/intersection_spec.rb +++ /dev/null @@ -1,19 +0,0 @@ -#! /usr/bin/env ruby -S rspec -require 'spec_helper' - -describe "the intersection function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - Puppet::Parser::Functions.function("intersection").should == "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) ) - 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"])) - end -end diff --git a/spec/unit/puppet/parser/functions/is_array_spec.rb b/spec/unit/puppet/parser/functions/is_array_spec.rb deleted file mode 100644 index e7f4bcd6d..000000000 --- a/spec/unit/puppet/parser/functions/is_array_spec.rb +++ /dev/null @@ -1,29 +0,0 @@ -#! /usr/bin/env ruby -S rspec -require 'spec_helper' - -describe "the is_array function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - Puppet::Parser::Functions.function("is_array").should == "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)) - end - - it "should return true if passed an array" do - result = scope.function_is_array([[1,2,3]]) - result.should(eq(true)) - end - - it "should return false if passed a hash" do - result = scope.function_is_array([{'a'=>1}]) - result.should(eq(false)) - end - - it "should return false if passed a string" do - result = scope.function_is_array(["asdf"]) - result.should(eq(false)) - end -end diff --git a/spec/unit/puppet/parser/functions/is_bool_spec.rb b/spec/unit/puppet/parser/functions/is_bool_spec.rb deleted file mode 100644 index c94e83a9d..000000000 --- a/spec/unit/puppet/parser/functions/is_bool_spec.rb +++ /dev/null @@ -1,44 +0,0 @@ -#! /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 diff --git a/spec/unit/puppet/parser/functions/is_domain_name_spec.rb b/spec/unit/puppet/parser/functions/is_domain_name_spec.rb deleted file mode 100644 index f2ea76dac..000000000 --- a/spec/unit/puppet/parser/functions/is_domain_name_spec.rb +++ /dev/null @@ -1,64 +0,0 @@ -#! /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 - Puppet::Parser::Functions.function("is_domain_name").should == "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)) - end - - it "should return true if a valid short domain name" do - result = scope.function_is_domain_name(["x.com"]) - result.should(be_true) - end - - it "should return true if the domain is ." do - result = scope.function_is_domain_name(["."]) - result.should(be_true) - end - - it "should return true if the domain is x.com." do - result = scope.function_is_domain_name(["x.com."]) - result.should(be_true) - end - - it "should return true if a valid domain name" do - result = scope.function_is_domain_name(["foo.bar.com"]) - result.should(be_true) - end - - it "should allow domain parts to start with numbers" do - result = scope.function_is_domain_name(["3foo.2bar.com"]) - result.should(be_true) - end - - it "should allow domain to end with a dot" do - result = scope.function_is_domain_name(["3foo.2bar.com."]) - result.should(be_true) - end - - it "should allow a single part domain" do - result = scope.function_is_domain_name(["orange"]) - result.should(be_true) - 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) - 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) - end - - it "should return false if domain name contains spaces" do - result = scope.function_is_domain_name(["not valid"]) - result.should(be_false) - end -end diff --git a/spec/unit/puppet/parser/functions/is_float_spec.rb b/spec/unit/puppet/parser/functions/is_float_spec.rb deleted file mode 100644 index b7d73b04a..000000000 --- a/spec/unit/puppet/parser/functions/is_float_spec.rb +++ /dev/null @@ -1,33 +0,0 @@ -#! /usr/bin/env ruby -S rspec -require 'spec_helper' - -describe "the is_float function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - Puppet::Parser::Functions.function("is_float").should == "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)) - end - - it "should return true if a float" do - result = scope.function_is_float(["0.12"]) - result.should(eq(true)) - end - - it "should return false if a string" do - result = scope.function_is_float(["asdf"]) - result.should(eq(false)) - end - - it "should return false if an integer" do - result = scope.function_is_float(["3"]) - result.should(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)) - end -end diff --git a/spec/unit/puppet/parser/functions/is_function_available.rb b/spec/unit/puppet/parser/functions/is_function_available.rb deleted file mode 100644 index d5669a758..000000000 --- a/spec/unit/puppet/parser/functions/is_function_available.rb +++ /dev/null @@ -1,31 +0,0 @@ -#!/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 - Puppet::Parser::Functions.function("is_function_available").should == "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)) - 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)) - end - - it "should return true if an available function is passed" do - result = @scope.function_is_function_available(['require']) - result.should(eq(true)) - end - -end diff --git a/spec/unit/puppet/parser/functions/is_hash_spec.rb b/spec/unit/puppet/parser/functions/is_hash_spec.rb deleted file mode 100644 index bbebf39f9..000000000 --- a/spec/unit/puppet/parser/functions/is_hash_spec.rb +++ /dev/null @@ -1,29 +0,0 @@ -#! /usr/bin/env ruby -S rspec -require 'spec_helper' - -describe "the is_hash function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - Puppet::Parser::Functions.function("is_hash").should == "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)) - end - - it "should return true if passed a hash" do - result = scope.function_is_hash([{"a"=>1,"b"=>2}]) - result.should(eq(true)) - end - - it "should return false if passed an array" do - result = scope.function_is_hash([["a","b"]]) - result.should(eq(false)) - end - - it "should return false if passed a string" do - result = scope.function_is_hash(["asdf"]) - result.should(eq(false)) - end -end diff --git a/spec/unit/puppet/parser/functions/is_integer_spec.rb b/spec/unit/puppet/parser/functions/is_integer_spec.rb deleted file mode 100644 index 433579502..000000000 --- a/spec/unit/puppet/parser/functions/is_integer_spec.rb +++ /dev/null @@ -1,34 +0,0 @@ -#! /usr/bin/env ruby -S rspec -require 'spec_helper' - -describe "the is_integer function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - Puppet::Parser::Functions.function("is_integer").should == "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)) - end - - it "should return true if an integer" do - result = scope.function_is_integer(["3"]) - result.should(eq(true)) - end - - it "should return false if a float" do - result = scope.function_is_integer(["3.2"]) - result.should(eq(false)) - end - - it "should return false if a string" do - result = scope.function_is_integer(["asdf"]) - result.should(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)) - end -end diff --git a/spec/unit/puppet/parser/functions/is_ip_address_spec.rb b/spec/unit/puppet/parser/functions/is_ip_address_spec.rb deleted file mode 100644 index c0debb3d4..000000000 --- a/spec/unit/puppet/parser/functions/is_ip_address_spec.rb +++ /dev/null @@ -1,39 +0,0 @@ -#! /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 - Puppet::Parser::Functions.function("is_ip_address").should == "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)) - end - - it "should return true if an IPv4 address" do - result = scope.function_is_ip_address(["1.2.3.4"]) - result.should(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)) - end - - it "should return true if a compressed IPv6 address" do - result = scope.function_is_ip_address(["fe00::1"]) - result.should(eq(true)) - end - - it "should return false if not valid" do - result = scope.function_is_ip_address(["asdf"]) - result.should(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)) - end -end diff --git a/spec/unit/puppet/parser/functions/is_mac_address_spec.rb b/spec/unit/puppet/parser/functions/is_mac_address_spec.rb deleted file mode 100644 index ca9c59047..000000000 --- a/spec/unit/puppet/parser/functions/is_mac_address_spec.rb +++ /dev/null @@ -1,29 +0,0 @@ -#! /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 - Puppet::Parser::Functions.function("is_mac_address").should == "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)) - 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)) - 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)) - end - - it "should return false if not valid" do - result = scope.function_is_mac_address(["not valid"]) - 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 deleted file mode 100644 index d7440fb0a..000000000 --- a/spec/unit/puppet/parser/functions/is_numeric_spec.rb +++ /dev/null @@ -1,39 +0,0 @@ -#! /usr/bin/env ruby -S rspec -require 'spec_helper' - -describe "the is_numeric function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - Puppet::Parser::Functions.function("is_numeric").should == "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)) - end - - it "should return true if an integer" do - result = scope.function_is_numeric(["3"]) - result.should(eq(true)) - end - - it "should return true if a float" do - result = scope.function_is_numeric(["3.2"]) - result.should(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)) - 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)) - end - - it "should return false if a string" do - result = scope.function_is_numeric(["asdf"]) - result.should(eq(false)) - end -end diff --git a/spec/unit/puppet/parser/functions/is_string_spec.rb b/spec/unit/puppet/parser/functions/is_string_spec.rb deleted file mode 100644 index 3756bea8b..000000000 --- a/spec/unit/puppet/parser/functions/is_string_spec.rb +++ /dev/null @@ -1,34 +0,0 @@ -#! /usr/bin/env ruby -S rspec -require 'spec_helper' - -describe "the is_string function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - Puppet::Parser::Functions.function("is_string").should == "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)) - end - - it "should return true if a string" do - result = scope.function_is_string(["asdf"]) - result.should(eq(true)) - end - - it "should return false if an integer" do - result = scope.function_is_string(["3"]) - result.should(eq(false)) - end - - it "should return false if a float" do - result = scope.function_is_string(["3.23"]) - result.should(eq(false)) - end - - it "should return false if an array" do - result = scope.function_is_string([["a","b","c"]]) - result.should(eq(false)) - end -end 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 deleted file mode 100644 index a52fb719f..000000000 --- a/spec/unit/puppet/parser/functions/join_keys_to_values_spec.rb +++ /dev/null @@ -1,40 +0,0 @@ -#! /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 - Puppet::Parser::Functions.function("join_keys_to_values").should == "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 - 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 - 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 - 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 - 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 - end - - it "should return an empty array given an empty hash" do - result = scope.function_join_keys_to_values([{}, ":"]) - result.should == [] - 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:'] - end -end diff --git a/spec/unit/puppet/parser/functions/join_spec.rb b/spec/unit/puppet/parser/functions/join_spec.rb deleted file mode 100644 index aafa1a7f7..000000000 --- a/spec/unit/puppet/parser/functions/join_spec.rb +++ /dev/null @@ -1,19 +0,0 @@ -#! /usr/bin/env ruby -S rspec -require 'spec_helper' - -describe "the join function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - Puppet::Parser::Functions.function("join").should == "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)) - end - - it "should join an array into a string" do - result = scope.function_join([["a","b","c"], ":"]) - result.should(eq("a:b:c")) - end -end diff --git a/spec/unit/puppet/parser/functions/keys_spec.rb b/spec/unit/puppet/parser/functions/keys_spec.rb deleted file mode 100644 index fdd7a7073..000000000 --- a/spec/unit/puppet/parser/functions/keys_spec.rb +++ /dev/null @@ -1,21 +0,0 @@ -#! /usr/bin/env ruby -S rspec -require 'spec_helper' - -describe "the keys function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - Puppet::Parser::Functions.function("keys").should == "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)) - 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'] - end -end diff --git a/spec/unit/puppet/parser/functions/loadyaml_spec.rb b/spec/unit/puppet/parser/functions/loadyaml_spec.rb deleted file mode 100644 index fe1631826..000000000 --- a/spec/unit/puppet/parser/functions/loadyaml_spec.rb +++ /dev/null @@ -1,25 +0,0 @@ -#! /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 - Puppet::Parser::Functions.function("loadyaml").should == "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) - 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]) - result.should == {"aaa" => 1, "bbb" => 2, "ccc" => 3, "ddd" => 4 } - end -end diff --git a/spec/unit/puppet/parser/functions/lstrip_spec.rb b/spec/unit/puppet/parser/functions/lstrip_spec.rb deleted file mode 100644 index b280ae7ac..000000000 --- a/spec/unit/puppet/parser/functions/lstrip_spec.rb +++ /dev/null @@ -1,19 +0,0 @@ -#! /usr/bin/env ruby -S rspec -require 'spec_helper' - -describe "the lstrip function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - Puppet::Parser::Functions.function("lstrip").should == "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)) - end - - it "should lstrip a string" do - result = scope.function_lstrip([" asdf"]) - result.should(eq('asdf')) - end -end diff --git a/spec/unit/puppet/parser/functions/max_spec.rb b/spec/unit/puppet/parser/functions/max_spec.rb deleted file mode 100755 index ff6f2b361..000000000 --- a/spec/unit/puppet/parser/functions/max_spec.rb +++ /dev/null @@ -1,27 +0,0 @@ -#! /usr/bin/env ruby -S rspec - -require 'spec_helper' - -describe "the max function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - Puppet::Parser::Functions.function("max").should == "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)) - end - - it "should be able to compare strings" do - scope.function_max(["albatross","dog","horse"]).should(eq("horse")) - end - - it "should be able to compare numbers" do - scope.function_max([6,8,4]).should(eq(8)) - end - - it "should be able to compare a number with a stringified number" do - scope.function_max([1,"2"]).should(eq("2")) - end -end diff --git a/spec/unit/puppet/parser/functions/member_spec.rb b/spec/unit/puppet/parser/functions/member_spec.rb deleted file mode 100644 index 6e9a023fa..000000000 --- a/spec/unit/puppet/parser/functions/member_spec.rb +++ /dev/null @@ -1,24 +0,0 @@ -#! /usr/bin/env ruby -S rspec -require 'spec_helper' - -describe "the member function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - Puppet::Parser::Functions.function("member").should == "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)) - 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)) - 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)) - end -end diff --git a/spec/unit/puppet/parser/functions/merge_spec.rb b/spec/unit/puppet/parser/functions/merge_spec.rb deleted file mode 100644 index 8a170bb1c..000000000 --- a/spec/unit/puppet/parser/functions/merge_spec.rb +++ /dev/null @@ -1,52 +0,0 @@ -#! /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 - pending("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 - pending("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(Puppet::ParseError, /unexpected argument type String/) - end - - 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' - end - - it 'should merge multiple hashes' do - hash = scope.function_merge([{'one' => 1}, {'one' => '2'}, {'one' => '3'}]) - hash['one'].should == '3' - end - - it 'should accept empty hashes' do - scope.function_merge([{},{},{}]).should == {} - end - end -end diff --git a/spec/unit/puppet/parser/functions/min_spec.rb b/spec/unit/puppet/parser/functions/min_spec.rb deleted file mode 100755 index 71d593ef0..000000000 --- a/spec/unit/puppet/parser/functions/min_spec.rb +++ /dev/null @@ -1,27 +0,0 @@ -#! /usr/bin/env ruby -S rspec - -require 'spec_helper' - -describe "the min function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - Puppet::Parser::Functions.function("min").should == "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)) - end - - it "should be able to compare strings" do - scope.function_min(["albatross","dog","horse"]).should(eq("albatross")) - end - - it "should be able to compare numbers" do - scope.function_min([6,8,4]).should(eq(4)) - end - - it "should be able to compare a number with a stringified number" do - scope.function_min([1,"2"]).should(eq(1)) - end -end diff --git a/spec/unit/puppet/parser/functions/num2bool_spec.rb b/spec/unit/puppet/parser/functions/num2bool_spec.rb deleted file mode 100644 index b56196d3c..000000000 --- a/spec/unit/puppet/parser/functions/num2bool_spec.rb +++ /dev/null @@ -1,67 +0,0 @@ -#! /usr/bin/env ruby -S rspec -require 'spec_helper' - -describe "the num2bool function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - Puppet::Parser::Functions.function("num2bool").should == "function_num2bool" - end - - it "should raise a ParseError if there are no arguments" do - lambda { scope.function_num2bool([]) }.should( 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)) - end - - it "should raise a ParseError if passed something non-numeric" do - lambda { scope.function_num2bool(["xyzzy"]) }.should( raise_error(Puppet::ParseError)) - end - - it "should return true if passed string 1" do - result = scope.function_num2bool(["1"]) - result.should(be_true) - end - - it "should return true if passed string 1.5" do - result = scope.function_num2bool(["1.5"]) - result.should(be_true) - end - - it "should return true if passed number 1" do - result = scope.function_num2bool([1]) - result.should(be_true) - end - - it "should return false if passed string 0" do - result = scope.function_num2bool(["0"]) - result.should(be_false) - end - - it "should return false if passed number 0" do - result = scope.function_num2bool([0]) - result.should(be_false) - end - - it "should return false if passed string -1" do - result = scope.function_num2bool(["-1"]) - result.should(be_false) - end - - it "should return false if passed string -1.5" do - result = scope.function_num2bool(["-1.5"]) - result.should(be_false) - end - - it "should return false if passed number -1" do - result = scope.function_num2bool([-1]) - result.should(be_false) - end - - it "should return false if passed float -1.5" do - result = scope.function_num2bool([-1.5]) - result.should(be_false) - end -end diff --git a/spec/unit/puppet/parser/functions/parsejson_spec.rb b/spec/unit/puppet/parser/functions/parsejson_spec.rb deleted file mode 100644 index f179ac111..000000000 --- a/spec/unit/puppet/parser/functions/parsejson_spec.rb +++ /dev/null @@ -1,22 +0,0 @@ -#! /usr/bin/env ruby -S rspec -require 'spec_helper' - -describe "the parsejson function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - Puppet::Parser::Functions.function("parsejson").should == "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)) - end - - it "should convert JSON to a data structure" do - json = <<-EOS -["aaa","bbb","ccc"] -EOS - result = scope.function_parsejson([json]) - result.should(eq(['aaa','bbb','ccc'])) - end -end diff --git a/spec/unit/puppet/parser/functions/parseyaml_spec.rb b/spec/unit/puppet/parser/functions/parseyaml_spec.rb deleted file mode 100644 index 0c7aea8a5..000000000 --- a/spec/unit/puppet/parser/functions/parseyaml_spec.rb +++ /dev/null @@ -1,24 +0,0 @@ -#! /usr/bin/env ruby -S rspec -require 'spec_helper' - -describe "the parseyaml function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - Puppet::Parser::Functions.function("parseyaml").should == "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)) - end - - it "should convert YAML to a data structure" do - yaml = <<-EOS -- aaa -- bbb -- ccc -EOS - result = scope.function_parseyaml([yaml]) - result.should(eq(['aaa','bbb','ccc'])) - end -end diff --git a/spec/unit/puppet/parser/functions/pick_spec.rb b/spec/unit/puppet/parser/functions/pick_spec.rb deleted file mode 100755 index f53fa8000..000000000 --- a/spec/unit/puppet/parser/functions/pick_spec.rb +++ /dev/null @@ -1,34 +0,0 @@ -#!/usr/bin/env ruby -S rspec -require 'spec_helper' - -describe "the pick function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - Puppet::Parser::Functions.function("pick").should == "function_pick" - end - - it 'should return the correct value' do - scope.function_pick(['first', 'second']).should == 'first' - end - - it 'should return the correct value if the first value is empty' do - scope.function_pick(['', 'second']).should == 'second' - end - - it 'should remove empty string values' do - scope.function_pick(['', 'first']).should == 'first' - end - - it 'should remove :undef values' do - scope.function_pick([:undef, 'first']).should == 'first' - end - - it 'should remove :undefined values' do - scope.function_pick([:undefined, 'first']).should == '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 -end diff --git a/spec/unit/puppet/parser/functions/prefix_spec.rb b/spec/unit/puppet/parser/functions/prefix_spec.rb deleted file mode 100644 index 6e8ddc58e..000000000 --- a/spec/unit/puppet/parser/functions/prefix_spec.rb +++ /dev/null @@ -1,28 +0,0 @@ -#! /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']) - result.should(eq(['pa','pb','pc'])) - end -end diff --git a/spec/unit/puppet/parser/functions/range_spec.rb b/spec/unit/puppet/parser/functions/range_spec.rb deleted file mode 100644 index 0e1ad376f..000000000 --- a/spec/unit/puppet/parser/functions/range_spec.rb +++ /dev/null @@ -1,70 +0,0 @@ -#! /usr/bin/env ruby -S rspec -require 'spec_helper' - -describe "the range function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "exists" do - Puppet::Parser::Functions.function("range").should == "function_range" - 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/ - end - - 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'] - 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'] - end - - it "returns a stepped letter range" do - result = scope.function_range(["a","d","2"]) - result.should 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'] - 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] - 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] - end - - it "returns a stepped number range" do - result = scope.function_range(["1","4","2"]) - result.should 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] - 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 - end - - it "coerces zero padded digits to integers" do - expected = (0..10).to_a - scope.function_range(["00", "10"]).should eq expected - end - end -end diff --git a/spec/unit/puppet/parser/functions/reject_spec.rb b/spec/unit/puppet/parser/functions/reject_spec.rb deleted file mode 100755 index f2cb74193..000000000 --- a/spec/unit/puppet/parser/functions/reject_spec.rb +++ /dev/null @@ -1,20 +0,0 @@ -#!/usr/bin/env ruby - -require 'spec_helper' - -describe "the reject function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - Puppet::Parser::Functions.function("reject").should == "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)) - end - - it "should reject contents from an array" do - result = scope.function_reject([["1111", "aaabbb","bbbccc","dddeee"], "bbb"]) - result.should(eq(["1111", "dddeee"])) - end -end diff --git a/spec/unit/puppet/parser/functions/reverse_spec.rb b/spec/unit/puppet/parser/functions/reverse_spec.rb deleted file mode 100644 index 1b5920654..000000000 --- a/spec/unit/puppet/parser/functions/reverse_spec.rb +++ /dev/null @@ -1,19 +0,0 @@ -#! /usr/bin/env ruby -S rspec -require 'spec_helper' - -describe "the reverse function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - Puppet::Parser::Functions.function("reverse").should == "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)) - end - - it "should reverse a string" do - result = scope.function_reverse(["asdfghijkl"]) - result.should(eq('lkjihgfdsa')) - end -end diff --git a/spec/unit/puppet/parser/functions/rstrip_spec.rb b/spec/unit/puppet/parser/functions/rstrip_spec.rb deleted file mode 100644 index d90de1d06..000000000 --- a/spec/unit/puppet/parser/functions/rstrip_spec.rb +++ /dev/null @@ -1,24 +0,0 @@ -#! /usr/bin/env ruby -S rspec -require 'spec_helper' - -describe "the rstrip function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - Puppet::Parser::Functions.function("rstrip").should == "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)) - end - - it "should rstrip a string" do - result = scope.function_rstrip(["asdf "]) - result.should(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'])) - end -end diff --git a/spec/unit/puppet/parser/functions/shuffle_spec.rb b/spec/unit/puppet/parser/functions/shuffle_spec.rb deleted file mode 100644 index 93346d537..000000000 --- a/spec/unit/puppet/parser/functions/shuffle_spec.rb +++ /dev/null @@ -1,24 +0,0 @@ -#! /usr/bin/env ruby -S rspec -require 'spec_helper' - -describe "the shuffle function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - Puppet::Parser::Functions.function("shuffle").should == "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)) - 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)) - 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")) - end -end diff --git a/spec/unit/puppet/parser/functions/size_spec.rb b/spec/unit/puppet/parser/functions/size_spec.rb deleted file mode 100644 index b1c435a30..000000000 --- a/spec/unit/puppet/parser/functions/size_spec.rb +++ /dev/null @@ -1,24 +0,0 @@ -#! /usr/bin/env ruby -S rspec -require 'spec_helper' - -describe "the size function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - Puppet::Parser::Functions.function("size").should == "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)) - end - - it "should return the size of a string" do - result = scope.function_size(["asdf"]) - result.should(eq(4)) - end - - it "should return the size of an array" do - result = scope.function_size([["a","b","c"]]) - result.should(eq(3)) - end -end diff --git a/spec/unit/puppet/parser/functions/sort_spec.rb b/spec/unit/puppet/parser/functions/sort_spec.rb deleted file mode 100644 index 3187a5aec..000000000 --- a/spec/unit/puppet/parser/functions/sort_spec.rb +++ /dev/null @@ -1,24 +0,0 @@ -#! /usr/bin/env ruby -S rspec -require 'spec_helper' - -describe "the sort function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - Puppet::Parser::Functions.function("sort").should == "function_sort" - end - - it "should raise a ParseError if there is not 1 arguments" do - lambda { scope.function_sort(['','']) }.should( raise_error(Puppet::ParseError)) - end - - it "should sort an array" do - result = scope.function_sort([["a","c","b"]]) - result.should(eq(['a','b','c'])) - end - - it "should sort a string" do - result = scope.function_sort(["acb"]) - result.should(eq('abc')) - end -end diff --git a/spec/unit/puppet/parser/functions/squeeze_spec.rb b/spec/unit/puppet/parser/functions/squeeze_spec.rb deleted file mode 100644 index 60e5a3028..000000000 --- a/spec/unit/puppet/parser/functions/squeeze_spec.rb +++ /dev/null @@ -1,24 +0,0 @@ -#! /usr/bin/env ruby -S rspec -require 'spec_helper' - -describe "the squeeze function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - Puppet::Parser::Functions.function("squeeze").should == "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)) - end - - it "should squeeze a string" do - result = scope.function_squeeze(["aaabbbbcccc"]) - result.should(eq('abc')) - end - - it "should squeeze all elements in an array" do - result = scope.function_squeeze([["aaabbbbcccc","dddfff"]]) - result.should(eq(['abc','df'])) - end -end diff --git a/spec/unit/puppet/parser/functions/str2bool_spec.rb b/spec/unit/puppet/parser/functions/str2bool_spec.rb deleted file mode 100644 index ef6350f25..000000000 --- a/spec/unit/puppet/parser/functions/str2bool_spec.rb +++ /dev/null @@ -1,31 +0,0 @@ -#! /usr/bin/env ruby -S rspec -require 'spec_helper' - -describe "the str2bool function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - Puppet::Parser::Functions.function("str2bool").should == "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)) - end - - it "should convert string 'true' to true" do - result = scope.function_str2bool(["true"]) - result.should(eq(true)) - end - - it "should convert string 'undef' to false" do - 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)) - result = scope.function_str2bool([false]) - result.should(eq(false)) - end -end diff --git a/spec/unit/puppet/parser/functions/str2saltedsha512_spec.rb b/spec/unit/puppet/parser/functions/str2saltedsha512_spec.rb deleted file mode 100644 index df8fb8e90..000000000 --- a/spec/unit/puppet/parser/functions/str2saltedsha512_spec.rb +++ /dev/null @@ -1,45 +0,0 @@ -#! /usr/bin/env ruby -S rspec -require 'spec_helper' - -describe "the str2saltedsha512 function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - Puppet::Parser::Functions.function("str2saltedsha512").should == "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"]) - result.length.should(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*') - - # 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 - end -end diff --git a/spec/unit/puppet/parser/functions/strftime_spec.rb b/spec/unit/puppet/parser/functions/strftime_spec.rb deleted file mode 100644 index df42b6f26..000000000 --- a/spec/unit/puppet/parser/functions/strftime_spec.rb +++ /dev/null @@ -1,29 +0,0 @@ -#! /usr/bin/env ruby -S rspec -require 'spec_helper' - -describe "the strftime function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - Puppet::Parser::Functions.function("strftime").should == "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)) - 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) - end - - it "using %s should be lower then 1.5 trillion" do - result = scope.function_strftime(["%s"]) - result.to_i.should(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}$/ - end -end diff --git a/spec/unit/puppet/parser/functions/strip_spec.rb b/spec/unit/puppet/parser/functions/strip_spec.rb deleted file mode 100644 index fccdd2606..000000000 --- a/spec/unit/puppet/parser/functions/strip_spec.rb +++ /dev/null @@ -1,18 +0,0 @@ -#! /usr/bin/env ruby -S rspec -require 'spec_helper' - -describe "the strip function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - it "should exist" do - Puppet::Parser::Functions.function("strip").should == "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)) - end - - it "should strip a string" do - result = scope.function_strip([" ab cd "]) - result.should(eq('ab cd')) - end -end diff --git a/spec/unit/puppet/parser/functions/suffix_spec.rb b/spec/unit/puppet/parser/functions/suffix_spec.rb deleted file mode 100644 index 89ba3b823..000000000 --- a/spec/unit/puppet/parser/functions/suffix_spec.rb +++ /dev/null @@ -1,27 +0,0 @@ -#! /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']) - result.should(eq(['ap','bp','cp'])) - end -end diff --git a/spec/unit/puppet/parser/functions/swapcase_spec.rb b/spec/unit/puppet/parser/functions/swapcase_spec.rb deleted file mode 100644 index 808b41587..000000000 --- a/spec/unit/puppet/parser/functions/swapcase_spec.rb +++ /dev/null @@ -1,19 +0,0 @@ -#! /usr/bin/env ruby -S rspec -require 'spec_helper' - -describe "the swapcase function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - Puppet::Parser::Functions.function("swapcase").should == "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)) - end - - it "should swapcase a string" do - result = scope.function_swapcase(["aaBBccDD"]) - result.should(eq('AAbbCCdd')) - end -end diff --git a/spec/unit/puppet/parser/functions/time_spec.rb b/spec/unit/puppet/parser/functions/time_spec.rb deleted file mode 100644 index e9fb76e6a..000000000 --- a/spec/unit/puppet/parser/functions/time_spec.rb +++ /dev/null @@ -1,29 +0,0 @@ -#! /usr/bin/env ruby -S rspec -require 'spec_helper' - -describe "the time function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - Puppet::Parser::Functions.function("time").should == "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)) - end - - it "should return a number" do - result = scope.function_time([]) - result.should be_an(Integer) - end - - it "should be higher then when I wrote this test" do - result = scope.function_time([]) - result.should(be > 1311953157) - end - - it "should be lower then 1.5 trillion" do - result = scope.function_time([]) - result.should(be < 1500000000) - end -end diff --git a/spec/unit/puppet/parser/functions/to_bytes_spec.rb b/spec/unit/puppet/parser/functions/to_bytes_spec.rb deleted file mode 100755 index d1ea4c80c..000000000 --- a/spec/unit/puppet/parser/functions/to_bytes_spec.rb +++ /dev/null @@ -1,58 +0,0 @@ -#! /usr/bin/env ruby -S rspec - -require 'spec_helper' - -describe "the to_bytes function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - Puppet::Parser::Functions.function("to_bytes").should == "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)) - end - - it "should convert kB to B" do - result = scope.function_to_bytes(["4 kB"]) - result.should(eq(4096)) - end - - it "should work without B in unit" do - result = scope.function_to_bytes(["4 k"]) - result.should(eq(4096)) - end - - it "should work without a space before unit" do - result = scope.function_to_bytes(["4k"]) - result.should(eq(4096)) - end - - it "should work without a unit" do - result = scope.function_to_bytes(["5678"]) - result.should(eq(5678)) - end - - it "should convert fractions" do - result = scope.function_to_bytes(["1.5 kB"]) - result.should(eq(1536)) - end - - it "should convert scientific notation" do - result = scope.function_to_bytes(["1.5e2 B"]) - result.should(eq(150)) - end - - it "should do nothing with a positive number" do - result = scope.function_to_bytes([5678]) - result.should(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)) - end - - it "should should raise a ParseError if prefix is unknown" do - lambda { scope.function_to_bytes(["5 uB"]) }.should( raise_error(Puppet::ParseError)) - end -end diff --git a/spec/unit/puppet/parser/functions/type_spec.rb b/spec/unit/puppet/parser/functions/type_spec.rb deleted file mode 100644 index 8fec88f26..000000000 --- a/spec/unit/puppet/parser/functions/type_spec.rb +++ /dev/null @@ -1,43 +0,0 @@ -#! /usr/bin/env ruby -S rspec -require 'spec_helper' - -describe "the type function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - it "should exist" do - Puppet::Parser::Functions.function("type").should == "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)) - end - - it "should return string when given a string" do - result = scope.function_type(["aaabbbbcccc"]) - result.should(eq('string')) - end - - it "should return array when given an array" do - result = scope.function_type([["aaabbbbcccc","asdf"]]) - result.should(eq('array')) - end - - it "should return hash when given a hash" do - result = scope.function_type([{"a"=>1,"b"=>2}]) - result.should(eq('hash')) - end - - it "should return integer when given an integer" do - result = scope.function_type(["1"]) - result.should(eq('integer')) - end - - it "should return float when given a float" do - result = scope.function_type(["1.34"]) - result.should(eq('float')) - end - - it "should return boolean when given a boolean" do - result = scope.function_type([true]) - result.should(eq('boolean')) - end -end diff --git a/spec/unit/puppet/parser/functions/union_spec.rb b/spec/unit/puppet/parser/functions/union_spec.rb deleted file mode 100644 index 0d282caa6..000000000 --- a/spec/unit/puppet/parser/functions/union_spec.rb +++ /dev/null @@ -1,19 +0,0 @@ -#! /usr/bin/env ruby -S rspec -require 'spec_helper' - -describe "the union function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - Puppet::Parser::Functions.function("union").should == "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) ) - 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"])) - end -end diff --git a/spec/unit/puppet/parser/functions/unique_spec.rb b/spec/unit/puppet/parser/functions/unique_spec.rb deleted file mode 100644 index 5d48d49b7..000000000 --- a/spec/unit/puppet/parser/functions/unique_spec.rb +++ /dev/null @@ -1,24 +0,0 @@ -#! /usr/bin/env ruby -S rspec -require 'spec_helper' - -describe "the unique function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - Puppet::Parser::Functions.function("unique").should == "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)) - end - - it "should remove duplicate elements in a string" do - result = scope.function_unique(["aabbc"]) - result.should(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'])) - end -end diff --git a/spec/unit/puppet/parser/functions/upcase_spec.rb b/spec/unit/puppet/parser/functions/upcase_spec.rb deleted file mode 100644 index 5db55138a..000000000 --- a/spec/unit/puppet/parser/functions/upcase_spec.rb +++ /dev/null @@ -1,24 +0,0 @@ -#! /usr/bin/env ruby -S rspec -require 'spec_helper' - -describe "the upcase function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - Puppet::Parser::Functions.function("upcase").should == "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)) - end - - it "should upcase a string" do - result = scope.function_upcase(["abc"]) - result.should(eq('ABC')) - end - - it "should do nothing if a string is already upcase" do - result = scope.function_upcase(["ABC"]) - result.should(eq('ABC')) - end -end diff --git a/spec/unit/puppet/parser/functions/uriescape_spec.rb b/spec/unit/puppet/parser/functions/uriescape_spec.rb deleted file mode 100644 index 7211c8878..000000000 --- a/spec/unit/puppet/parser/functions/uriescape_spec.rb +++ /dev/null @@ -1,24 +0,0 @@ -#! /usr/bin/env ruby -S rspec -require 'spec_helper' - -describe "the uriescape function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - Puppet::Parser::Functions.function("uriescape").should == "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)) - end - - it "should uriescape a string" do - result = scope.function_uriescape([":/?#[]@!$&'()*+,;= \"{}"]) - result.should(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')) - end -end diff --git a/spec/unit/puppet/parser/functions/validate_absolute_path_spec.rb b/spec/unit/puppet/parser/functions/validate_absolute_path_spec.rb deleted file mode 100644 index 08aaf7899..000000000 --- a/spec/unit/puppet/parser/functions/validate_absolute_path_spec.rb +++ /dev/null @@ -1,83 +0,0 @@ -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) - 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 Puppet::ParseError - 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 Puppet::ParseError - end - end - end - end - - describe 'Invalid paths' do - context 'Garbage inputs' do - [ - nil, - [ nil ], - { 'foo' => 'bar' }, - { }, - '', - ].each do |path| - it "validate_absolute_path(#{path.inspect}) should fail" do - expect { subject.call [path] }.to raise_error Puppet::ParseError - end - end - end - - context 'Relative paths' do - %w{ - relative1 - . - .. - ./foo - ../foo - etc/puppetlabs/puppet - opt/puppet/bin - }.each do |path| - it "validate_absolute_path(#{path.inspect}) should fail" do - expect { subject.call [path] }.to raise_error Puppet::ParseError - end - end - end - end -end diff --git a/spec/unit/puppet/parser/functions/validate_array_spec.rb b/spec/unit/puppet/parser/functions/validate_array_spec.rb deleted file mode 100644 index 4b31cfde4..000000000 --- a/spec/unit/puppet/parser/functions/validate_array_spec.rb +++ /dev/null @@ -1,38 +0,0 @@ -#! /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 - - 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 - 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/) - end - end -end diff --git a/spec/unit/puppet/parser/functions/validate_augeas_spec.rb b/spec/unit/puppet/parser/functions/validate_augeas_spec.rb deleted file mode 100644 index ab5c140d1..000000000 --- a/spec/unit/puppet/parser/functions/validate_augeas_spec.rb +++ /dev/null @@ -1,102 +0,0 @@ -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 - 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'], - ] - - inputs.each do |input| - it "validate_augeas(#{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 = [ - [ "root:x:0:0:root\n", 'Passwd.lns' ], - [ "127.0.1.1\n", 'Hosts.lns' ], - ] - - 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 - end - end - - describe "Nicer Error Messages" do - # The intent here is to make sure the function returns the 3rd 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' ], - ] - - inputs.each do |input| - it "validate_augeas(#{input.inspect}) should fail" do - expect { subject.call input }.to raise_error /#{input[2]}/ - end - end - end - - describe "Passing simple unit 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 - end - end - - describe "Failing simple unit 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 - end - end - end -end diff --git a/spec/unit/puppet/parser/functions/validate_bool_spec.rb b/spec/unit/puppet/parser/functions/validate_bool_spec.rb deleted file mode 100644 index 261fb2352..000000000 --- a/spec/unit/puppet/parser/functions/validate_bool_spec.rb +++ /dev/null @@ -1,51 +0,0 @@ -#! /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 - - 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 - - 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 - end -end diff --git a/spec/unit/puppet/parser/functions/validate_cmd_spec.rb b/spec/unit/puppet/parser/functions/validate_cmd_spec.rb deleted file mode 100644 index a86cb014c..000000000 --- a/spec/unit/puppet/parser/functions/validate_cmd_spec.rb +++ /dev/null @@ -1,47 +0,0 @@ -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) - 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!/ - 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 - end -end diff --git a/spec/unit/puppet/parser/functions/validate_hash_spec.rb b/spec/unit/puppet/parser/functions/validate_hash_spec.rb deleted file mode 100644 index a0c35c230..000000000 --- a/spec/unit/puppet/parser/functions/validate_hash_spec.rb +++ /dev/null @@ -1,43 +0,0 @@ -#! /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 - - 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 - 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/unit/puppet/parser/functions/validate_ipv4_address_spec.rb b/spec/unit/puppet/parser/functions/validate_ipv4_address_spec.rb deleted file mode 100644 index 85536d364..000000000 --- a/spec/unit/puppet/parser/functions/validate_ipv4_address_spec.rb +++ /dev/null @@ -1,64 +0,0 @@ -#! /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(Puppet::ParseError, /is not a valid IPv4 address/) - 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/) - 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/) - end - end -end diff --git a/spec/unit/puppet/parser/functions/validate_ipv6_address_spec.rb b/spec/unit/puppet/parser/functions/validate_ipv6_address_spec.rb deleted file mode 100644 index 1fe530468..000000000 --- a/spec/unit/puppet/parser/functions/validate_ipv6_address_spec.rb +++ /dev/null @@ -1,67 +0,0 @@ -#! /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 - 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/) - 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(Puppet::ParseError, /not a valid IPv6 address/) - 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/unit/puppet/parser/functions/validate_re_spec.rb b/spec/unit/puppet/parser/functions/validate_re_spec.rb deleted file mode 100644 index d189efb66..000000000 --- a/spec/unit/puppet/parser/functions/validate_re_spec.rb +++ /dev/null @@ -1,76 +0,0 @@ -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 - 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 - end - end -end diff --git a/spec/unit/puppet/parser/functions/validate_slength_spec.rb b/spec/unit/puppet/parser/functions/validate_slength_spec.rb deleted file mode 100755 index 851835fa1..000000000 --- a/spec/unit/puppet/parser/functions/validate_slength_spec.rb +++ /dev/null @@ -1,67 +0,0 @@ -#! /usr/bin/env ruby -S rspec - -require 'spec_helper' - -describe "the validate_slength function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - Puppet::Parser::Functions.function("validate_slength").should == "function_validate_slength" - 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/ - 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/ - 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]) - end - - it "doesn't raise an error if the string is equal to the max length" do - scope.function_validate_slength(['input', 5]) - end - - it "doesn't raise an error if the string is equal to the min length" do - scope.function_validate_slength(['input', 10, 5]) - 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 - end -end diff --git a/spec/unit/puppet/parser/functions/validate_string_spec.rb b/spec/unit/puppet/parser/functions/validate_string_spec.rb deleted file mode 100644 index 3b4fb3e1d..000000000 --- a/spec/unit/puppet/parser/functions/validate_string_spec.rb +++ /dev/null @@ -1,60 +0,0 @@ -#! /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 - - 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 - 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 - end - end -end diff --git a/spec/unit/puppet/parser/functions/values_at_spec.rb b/spec/unit/puppet/parser/functions/values_at_spec.rb deleted file mode 100644 index 08e95a567..000000000 --- a/spec/unit/puppet/parser/functions/values_at_spec.rb +++ /dev/null @@ -1,38 +0,0 @@ -#! /usr/bin/env ruby -S rspec -require 'spec_helper' - -describe "the values_at function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - Puppet::Parser::Functions.function("values_at").should == "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)) - 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)) - end - - it "should return a value at from an array" do - result = scope.function_values_at([['a','b','c'],"1"]) - result.should(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'])) - 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'])) - 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'])) - end -end diff --git a/spec/unit/puppet/parser/functions/values_spec.rb b/spec/unit/puppet/parser/functions/values_spec.rb deleted file mode 100644 index 14ae41763..000000000 --- a/spec/unit/puppet/parser/functions/values_spec.rb +++ /dev/null @@ -1,31 +0,0 @@ -#! /usr/bin/env ruby -S rspec -require 'spec_helper' - -describe "the values function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - Puppet::Parser::Functions.function("values").should == "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)) - 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 } - 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 } - end - - it "should raise a ParseError unless a Hash is provided" do - lambda { scope.function_values([['a','b','c']]) }.should( raise_error(Puppet::ParseError)) - end -end diff --git a/spec/unit/puppet/parser/functions/zip_spec.rb b/spec/unit/puppet/parser/functions/zip_spec.rb deleted file mode 100644 index f45ab1730..000000000 --- a/spec/unit/puppet/parser/functions/zip_spec.rb +++ /dev/null @@ -1,15 +0,0 @@ -#! /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 - lambda { scope.function_zip([]) }.should( 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"]])) - end -end diff --git a/spec/unit/puppet/provider/file_line/ruby_alter_spec.rb b/spec/unit/puppet/provider/file_line/ruby_alter_spec.rb new file mode 100644 index 000000000..310ac5c97 --- /dev/null +++ b/spec/unit/puppet/provider/file_line/ruby_alter_spec.rb @@ -0,0 +1,389 @@ +# frozen_string_literal: true + +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.write(tmpfile, content) + end + + describe '#create' do + 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 + File.write(tmpfile, "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 + + 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 + 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 + + 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.write(tmpfile, "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.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 + + 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.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.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.write(tmpfile, "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.write(tmpfile, "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.write(tmpfile, "foo1\nfoo = blah\nfoo2\nfoo = baz") + expect(File.read(tmpfile).chomp).to eql("foo1\nfoo = blah\nfoo2\nfoo = baz") + end + end + 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 'when 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:, + match:, + ) + end + end + + before :each do + File.write(tmpfile, "foo1\nfoo2\nfoo = baz") + 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.write(tmpfile, "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.write(tmpfile, "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.write(tmpfile, 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.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.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.write(tmpfile, "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.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 + 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.write(tmpfile, "foo1\nfoo\nfoo2") + expect(@provider.exists?).to be true + end + + it 'removes one line if it matches' do + File.write(tmpfile, "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.write(tmpfile, "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.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.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.write(tmpfile, "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.write(tmpfile, "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.write(tmpfile, "foo1\nfoo\nfoo2") + @provider.destroy + expect(File.read(tmpfile)).to eql("foo1\nfoo\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', + match: '^export\ HTTP_PROXY\=', match_for_absence: true + ) + @provider = provider_class.new(@resource) + File.write(tmpfile, "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.write(tmpfile, "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 +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..0577e3017 100644 --- a/spec/unit/puppet/provider/file_line/ruby_spec.rb +++ b/spec/unit/puppet/provider/file_line/ruby_spec.rb @@ -1,224 +1,268 @@ -require 'puppet' -require 'tempfile' +# frozen_string_literal: true + +require 'spec_helper' + provider_class = Puppet::Type.type(:file_line).provider(:ruby) -describe provider_class do - context "when adding" do - let :tmpfile do - tmp = Tempfile.new('tmp') - path = tmp.path - tmp.close! - path +#  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.write(tmpfile, content) + end + + describe 'line parameter' do + context 'when line exists' do + let(:content) { 'foo' } + + it 'detects the line' do + expect(provider).to be_exists + end end - let :resource do - Puppet::Type::File_line.new( - {:name => 'foo', :path => tmpfile, :line => 'foo'} - ) + + context 'when line does not exist' do + let(:content) { 'foo bar' } + + 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") + end end - let :provider do - provider_class.new(resource) + 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 end - it 'should detect if the line exists in the file' do - File.open(tmpfile, 'w') do |fh| - fh.write('foo') + 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 - provider.exists?.should be_true end - it 'should detect if the line does not exist in the file' do - File.open(tmpfile, 'w') do |fh| - fh.write('foo1') + + context 'when does not match line - line exists' do + let(:content) { "foo\nbar" } + + it 'detects the line' do + expect(provider).to be_exists end - provider.exists?.should be_nil end - it 'should append to an existing file when creating' do - provider.create - File.read(tmpfile).chomp.should == 'foo' + + context 'when 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 'when matches line - line does not exist' do + let(:params) { { match: '^foo' } } + 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\nbar") + end end 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, - :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 - @provider.exists?.should 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") - 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 - @provider.exists?.should be_nil - @provider.create - File.read(@tmpfile).chomp.should eql("foo1\nfoo = bar\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*=.*$', - :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 - @provider.exists?.should be_nil - @provider.create - File.read(@tmpfile).chomp.should 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 - @provider.create - File.read(@tmpfile).should 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 - @provider.create - File.read(@tmpfile).chomp.should eql("foo1\nfoo = bar\nfoo2") - 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 '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 - File.read(@tmpfile).chomp.should eql("foo1\ninserted = line\nfoo = blah\nfoo2\nfoo = baz") - end - end - - context 'with two 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 - - 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 + describe 'append_on_no_match' do + 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).not_to be_exists + end + + it 'replaces the match' do + provider.create + expect(File.read(tmpfile).chomp).to eql("foo\nbar") + end + end + + context 'when not matching' do + let(:content) { "foo3\nbar" } + + it 'does not affect the file' do + expect(provider).to be_exists end end end - context "when removing" 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', :ensure => 'absent' } - ) - @provider = provider_class.new(@resource) + describe 'replace_all_matches_not_matching_line' do + context 'when replace is false' do + let(:params) do + { + replace_all_matches_not_matching_line: true, + replace: false + } + end + + it 'raises an error' do + expect { provider.exists? }.to raise_error(Puppet::Error, %r{replace must be true}) + end + end + + 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 + } + end + let(:content) { "foo\nfoo bar\nbar\nfoo baz" } + + 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") + end end - it 'should remove the line if it exists' do - File.open(@tmpfile, 'w') do |fh| - fh.write("foo1\nfoo\nfoo2") + + 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 + } + end + let(:content) { "foo\nfoo\nbar" } + + it 'does not request changes' do + expect(provider).to be_exists end - @provider.destroy - File.read(@tmpfile).should 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") + 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 + } + end + let(:content) { "foo\nfoo bar\nbar\nbar baz" } + + 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") end - @provider.destroy - File.read(@tmpfile).should 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") + 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 + } + end + let(:content) { "foo\nfoo\nbar\nbar baz" } + + it 'requests changes' do + expect(provider).not_to be_exists end - @provider.destroy - File.read(@tmpfile).should eql("foo1\nfoo2\n") + + it 'replaces the matches' do + provider.create + expect(File.read(tmpfile).chomp).to eql("foo\nfoo\nfoo\nfoo") + end + end + end + + 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 'does not request changes' do + expect(provider).to be_exists + end + end + + 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 '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") end end end diff --git a/spec/unit/puppet/provider/file_line/ruby_use_cases_spec.rb b/spec/unit/puppet/provider/file_line/ruby_use_cases_spec.rb new file mode 100644 index 000000000..b3578a679 --- /dev/null +++ b/spec/unit/puppet/provider/file_line/ruby_use_cases_spec.rb @@ -0,0 +1,137 @@ +# frozen_string_literal: true + +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.write(tmpfile, content) + 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 2030b83f2..9dc4ebd65 100644 --- a/spec/unit/puppet/type/anchor_spec.rb +++ b/spec/unit/puppet/type/anchor_spec.rb @@ -1,11 +1,11 @@ -#!/usr/bin/env ruby +# frozen_string_literal: true -require 'puppet' +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 - anchor.to_s.should == "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 edc64bd1e..17c4d8c7e 100644 --- a/spec/unit/puppet/type/file_line_spec.rb +++ b/spec/unit/puppet/type/file_line_spec.rb @@ -1,69 +1,128 @@ -require 'puppet' +# frozen_string_literal: true + +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 + + it 'accepts a line' do file_line[:line] = 'my_line' - file_line[:line].should == 'my_line' - file_line[:path] = '/my/path' - file_line[:path].should == '/my/path' + 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.*$' - 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 + + 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$' - )}.to raise_error(Puppet::Error, /the value must be a regex that matches/) + 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 posix filenames' do - file_line[:path] = '/tmp/path' - file_line[:path].should == '/tmp/path' + + it 'accepts utf8 characters' do + expect { + Puppet::Type.type(:file_line).new( + name: 'ƒồỗ', path: my_path, line: 'ƒồỗ=ьåя', match: '^ьåя=βļάħ$', + ) + }.not_to raise_error 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 'accepts double byte characters' do + expect { + Puppet::Type.type(:file_line).new( + name: 'フーバー', path: my_path, line: 'この=それ', match: '^この=ああ$', + ) + }.not_to raise_error 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/) + + it 'accepts posix filenames' do + file_line[:path] = tmp_path + expect(file_line[:path]).to eq(tmp_path) 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/) + + 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 default to ensure => present' do - file_line[:ensure].should eq :present + + 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 autorequire the file it manages" do + 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 + + 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| - (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 - 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 + it 'does 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 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 diff --git a/types/absolutepath.pp b/types/absolutepath.pp new file mode 100644 index 000000000..906bd6960 --- /dev/null +++ b/types/absolutepath.pp @@ -0,0 +1,2 @@ +# @summary A strict absolutepath type +type Stdlib::Absolutepath = Variant[Stdlib::Windowspath, Stdlib::Unixpath] diff --git a/types/base32.pp b/types/base32.pp new file mode 100644 index 000000000..9c8574d82 --- /dev/null +++ b/types/base32.pp @@ -0,0 +1,2 @@ +# @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 new file mode 100644 index 000000000..3fc198f6c --- /dev/null +++ b/types/base64.pp @@ -0,0 +1,2 @@ +# @summary Type to match base64 String +type Stdlib::Base64 = Pattern[/\A[a-zA-Z0-9\/\+]+={,2}\z/] 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]] diff --git a/types/datasize.pp b/types/datasize.pp new file mode 100644 index 000000000..6892c0171 --- /dev/null +++ b/types/datasize.pp @@ -0,0 +1,2 @@ +# @summary Validate the size of data +type Stdlib::Datasize = Pattern[/^\d+(?i:[kmgt]b?|b)$/] 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/] diff --git a/types/email.pp b/types/email.pp new file mode 100644 index 000000000..6103edb64 --- /dev/null +++ b/types/email.pp @@ -0,0 +1,5 @@ +# @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/] +# lint:endignore diff --git a/types/ensure/file.pp b/types/ensure/file.pp new file mode 100644 index 000000000..6d5928715 --- /dev/null +++ b/types/ensure/file.pp @@ -0,0 +1,2 @@ +# @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/file/directory.pp b/types/ensure/file/directory.pp new file mode 100644 index 000000000..1c4d2686d --- /dev/null +++ b/types/ensure/file/directory.pp @@ -0,0 +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 new file mode 100644 index 000000000..d35deafe5 --- /dev/null +++ b/types/ensure/file/file.pp @@ -0,0 +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 new file mode 100644 index 000000000..bc1276dbe --- /dev/null +++ b/types/ensure/file/link.pp @@ -0,0 +1,2 @@ +# Validate the ensure parameter of a "link" file resource +type Stdlib::Ensure::File::Link = Enum['link', 'absent'] 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]] diff --git a/types/ensure/service.pp b/types/ensure/service.pp new file mode 100644 index 000000000..af9c513a3 --- /dev/null +++ b/types/ensure/service.pp @@ -0,0 +1,2 @@ +# @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 new file mode 100644 index 000000000..2974a05f2 --- /dev/null +++ b/types/filemode.pp @@ -0,0 +1,5 @@ +# @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/] +# lint:endignore diff --git a/types/filesource.pp b/types/filesource.pp new file mode 100644 index 000000000..9c12d9ed2 --- /dev/null +++ b/types/filesource.pp @@ -0,0 +1,9 @@ +# @summary Validate the source parameter on file types +type Stdlib::Filesource = Variant[ + Stdlib::Absolutepath, + Stdlib::HTTPUrl, + Pattern[ + /\Afile:\/\/\/([^\n\/\0]+(\/)?)+\z/, + /\Apuppet:\/\/(([\w-]+\.?)+)?\/([^\n\/\0]+(\/)?)+\z/, + ], +] diff --git a/types/fqdn.pp b/types/fqdn.pp new file mode 100644 index 000000000..c2fbe09ae --- /dev/null +++ b/types/fqdn.pp @@ -0,0 +1,2 @@ +# @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 new file mode 100644 index 000000000..46f349bac --- /dev/null +++ b/types/host.pp @@ -0,0 +1,2 @@ +# @summary Validate a host (FQDN or IP address) +type Stdlib::Host = Variant[Stdlib::Fqdn, Stdlib::IP::Address] 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 new file mode 100644 index 000000000..1a73221eb --- /dev/null +++ b/types/httpstatus.pp @@ -0,0 +1,4 @@ +# @summary Validate a HTTP status code +# @deprecated Use Stdlib::Http::Status +# @see Stdlib::Http::Status +type Stdlib::HttpStatus = Stdlib::Http::Status diff --git a/types/httpsurl.pp b/types/httpsurl.pp new file mode 100644 index 000000000..1c878c3ba --- /dev/null +++ b/types/httpsurl.pp @@ -0,0 +1,2 @@ +# @summary Validate a HTTPS URL +type Stdlib::HTTPSUrl = Pattern[/(?i:\Ahttps:\/\/.*\z)/] diff --git a/types/httpurl.pp b/types/httpurl.pp new file mode 100644 index 000000000..2cf0bd970 --- /dev/null +++ b/types/httpurl.pp @@ -0,0 +1,2 @@ +# @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 new file mode 100644 index 000000000..b73d3a1f5 --- /dev/null +++ b/types/ip/address.pp @@ -0,0 +1,5 @@ +# @summary Validate an IP address +type Stdlib::IP::Address = Variant[ + Stdlib::IP::Address::V4, + Stdlib::IP::Address::V6, +] 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, +] diff --git a/types/ip/address/nosubnet.pp b/types/ip/address/nosubnet.pp new file mode 100644 index 000000000..2f24b5ed3 --- /dev/null +++ b/types/ip/address/nosubnet.pp @@ -0,0 +1,5 @@ +# 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 new file mode 100644 index 000000000..33f8f6fce --- /dev/null +++ b/types/ip/address/v4.pp @@ -0,0 +1,5 @@ +# 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/v4/cidr.pp b/types/ip/address/v4/cidr.pp new file mode 100644 index 000000000..f8befdf43 --- /dev/null +++ b/types/ip/address/v4/cidr.pp @@ -0,0 +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 new file mode 100644 index 000000000..daa798fe2 --- /dev/null +++ b/types/ip/address/v4/nosubnet.pp @@ -0,0 +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.pp b/types/ip/address/v6.pp new file mode 100644 index 000000000..e8ca7eb31 --- /dev/null +++ b/types/ip/address/v6.pp @@ -0,0 +1,7 @@ +# Validate an IPv6 address +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..5900fe49f --- /dev/null +++ b/types/ip/address/v6/alternative.pp @@ -0,0 +1,11 @@ +# 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/, + /\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/, +] +# lint:endignore diff --git a/types/ip/address/v6/cidr.pp b/types/ip/address/v6/cidr.pp new file mode 100644 index 000000000..9fce3ba5e --- /dev/null +++ b/types/ip/address/v6/cidr.pp @@ -0,0 +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/compressed.pp b/types/ip/address/v6/compressed.pp new file mode 100644 index 000000000..44f08df63 --- /dev/null +++ b/types/ip/address/v6/compressed.pp @@ -0,0 +1,11 @@ +# 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/, + /\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 new file mode 100644 index 000000000..f0c23212a --- /dev/null +++ b/types/ip/address/v6/full.pp @@ -0,0 +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 new file mode 100644 index 000000000..f2345c1b4 --- /dev/null +++ b/types/ip/address/v6/nosubnet.pp @@ -0,0 +1,6 @@ +# 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, + 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..376da0ac9 --- /dev/null +++ b/types/ip/address/v6/nosubnet/alternative.pp @@ -0,0 +1,11 @@ +# 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/, + /\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/, +] +# lint:endignore diff --git a/types/ip/address/v6/nosubnet/compressed.pp b/types/ip/address/v6/nosubnet/compressed.pp new file mode 100644 index 000000000..01b1f96b0 --- /dev/null +++ b/types/ip/address/v6/nosubnet/compressed.pp @@ -0,0 +1,11 @@ +# 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/, + /\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..4bfedcdaf --- /dev/null +++ b/types/ip/address/v6/nosubnet/full.pp @@ -0,0 +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/mac.pp b/types/mac.pp new file mode 100644 index 000000000..283c861c9 --- /dev/null +++ b/types/mac.pp @@ -0,0 +1,5 @@ +# @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 new file mode 100644 index 000000000..69c344b08 --- /dev/null +++ b/types/objectstore.pp @@ -0,0 +1,5 @@ +# @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 new file mode 100644 index 000000000..28f4f3b52 --- /dev/null +++ b/types/objectstore/gsuri.pp @@ -0,0 +1,2 @@ +# @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 new file mode 100644 index 000000000..eb03b3040 --- /dev/null +++ b/types/objectstore/s3uri.pp @@ -0,0 +1,2 @@ +# @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 new file mode 100644 index 000000000..eef4590a0 --- /dev/null +++ b/types/port.pp @@ -0,0 +1,2 @@ +# @summary Validate a port number +type Stdlib::Port = Integer[0, 65535] diff --git a/types/port/dynamic.pp b/types/port/dynamic.pp new file mode 100644 index 000000000..743261f0f --- /dev/null +++ b/types/port/dynamic.pp @@ -0,0 +1,2 @@ +# @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 new file mode 100644 index 000000000..2d3ed84c2 --- /dev/null +++ b/types/port/ephemeral.pp @@ -0,0 +1,2 @@ +# @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 new file mode 100644 index 000000000..c00784c6a --- /dev/null +++ b/types/port/privileged.pp @@ -0,0 +1,2 @@ +# @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 new file mode 100644 index 000000000..17ce92117 --- /dev/null +++ b/types/port/registered.pp @@ -0,0 +1,2 @@ +# @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 new file mode 100644 index 000000000..01b7433ad --- /dev/null +++ b/types/port/unprivileged.pp @@ -0,0 +1,2 @@ +# @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 new file mode 100644 index 000000000..1cc626ad5 --- /dev/null +++ b/types/port/user.pp @@ -0,0 +1,2 @@ +# @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 new file mode 100644 index 000000000..733ba7601 --- /dev/null +++ b/types/syslogfacility.pp @@ -0,0 +1,27 @@ +# @summary Validate a syslog facility +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', +] diff --git a/types/unixpath.pp b/types/unixpath.pp new file mode 100644 index 000000000..e610a107c --- /dev/null +++ b/types/unixpath.pp @@ -0,0 +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 new file mode 100644 index 000000000..6943cf614 --- /dev/null +++ b/types/windowspath.pp @@ -0,0 +1,2 @@ +# @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 new file mode 100644 index 000000000..2545cbc26 --- /dev/null +++ b/types/yes_no.pp @@ -0,0 +1,2 @@ +# @summary Validate a yes / no value +type Stdlib::Yes_no = Pattern[/\A(?i:(yes|no))\z/]