diff --git a/.github/workflows/nightly.yml b/.github/workflows/nightly.yml index d59437a..112c605 100644 --- a/.github/workflows/nightly.yml +++ b/.github/workflows/nightly.yml @@ -1,230 +1,230 @@ name: "nightly" on: schedule: - cron: '0 0 * * *' env: HONEYCOMB_WRITEKEY: 7f3c63a70eecc61d635917de46bea4e6 HONEYCOMB_DATASET: litmus tests jobs: setup_matrix: name: "Setup Test Matrix" runs-on: ubuntu-20.04 outputs: matrix: ${{ steps.get-matrix.outputs.matrix }} steps: - name: "Honeycomb: Start recording" uses: kvrhdn/gha-buildevents@v1.0.2 with: apikey: ${{ env.HONEYCOMB_WRITEKEY }} dataset: ${{ env.HONEYCOMB_DATASET }} job-status: ${{ job.status }} - name: "Honeycomb: Start first step" run: | echo STEP_ID=0 >> $GITHUB_ENV echo STEP_START=$(date +%s) >> $GITHUB_ENV - name: Checkout Source uses: actions/checkout@v2 if: ${{ github.repository_owner == 'puppetlabs' }} - name: Activate Ruby 2.7 uses: actions/setup-ruby@v1 if: ${{ github.repository_owner == 'puppetlabs' }} with: ruby-version: "2.7" - name: Cache gems uses: actions/cache@v2 if: ${{ github.repository_owner == 'puppetlabs' }} with: path: vendor/gems key: ${{ runner.os }}-${{ github.event_name }}-${{ hashFiles('**/Gemfile') }} restore-keys: | ${{ runner.os }}-${{ github.event_name }}- ${{ runner.os }}- - name: Install gems if: ${{ github.repository_owner == 'puppetlabs' }} run: | buildevents cmd $TRACE_ID $STEP_ID 'bundle config path vendor/gems' -- bundle config path vendor/gems buildevents cmd $TRACE_ID $STEP_ID 'bundle config jobs 8' -- bundle config jobs 8 buildevents cmd $TRACE_ID $STEP_ID 'bundle config retry 3' -- bundle config retry 3 buildevents cmd $TRACE_ID $STEP_ID 'bundle install' -- bundle install buildevents cmd $TRACE_ID $STEP_ID 'bundle clean' -- bundle clean - name: Setup Acceptance Test Matrix id: get-matrix if: ${{ github.repository_owner == 'puppetlabs' }} run: | if [ '${{ github.repository_owner }}' == 'puppetlabs' ]; then buildevents cmd $TRACE_ID $STEP_ID matrix_from_metadata -- bundle exec matrix_from_metadata else echo "::set-output name=matrix::{}" fi - name: "Honeycomb: Record setup time" if: ${{ always() }} run: | buildevents step $TRACE_ID $STEP_ID $STEP_START 'Setup Test Matrix' Acceptance: needs: - setup_matrix runs-on: ubuntu-20.04 strategy: fail-fast: false matrix: ${{fromJson(needs.setup_matrix.outputs.matrix)}} env: BUILDEVENT_FILE: '../buildevents.txt' steps: - run: | echo 'platform=${{ matrix.platform }}' >> $BUILDEVENT_FILE echo 'collection=${{ matrix.collection }}' >> $BUILDEVENT_FILE - name: "Honeycomb: Start recording" uses: kvrhdn/gha-buildevents@v1.0.2 with: apikey: ${{ env.HONEYCOMB_WRITEKEY }} dataset: ${{ env.HONEYCOMB_DATASET }} job-status: ${{ job.status }} matrix-key: ${{ matrix.platform }}-${{ matrix.collection }} - name: "Honeycomb: start first step" run: | echo STEP_ID=${{ matrix.platform }}-${{ matrix.collection }}-1 >> $GITHUB_ENV echo STEP_START=$(date +%s) >> $GITHUB_ENV - name: Checkout Source uses: actions/checkout@v2 - name: Activate Ruby 2.7 uses: actions/setup-ruby@v1 with: ruby-version: "2.7" - name: Cache gems uses: actions/cache@v2 with: path: vendor/gems key: ${{ runner.os }}-${{ github.event_name }}-${{ hashFiles('**/Gemfile') }} restore-keys: | ${{ runner.os }}-${{ github.event_name }}- ${{ runner.os }}- - name: "Honeycomb: Record cache setup time" if: ${{ always() }} run: | buildevents step $TRACE_ID $STEP_ID $STEP_START 'Cache retrieval' echo STEP_ID=${{ matrix.platform }}-${{ matrix.collection }}-2 >> $GITHUB_ENV echo STEP_START=$(date +%s) >> $GITHUB_ENV - name: Bundler Setup run: | buildevents cmd $TRACE_ID $STEP_ID 'bundle config path vendor/gems' -- bundle config path vendor/gems buildevents cmd $TRACE_ID $STEP_ID 'bundle config jobs 8' -- bundle config jobs 8 buildevents cmd $TRACE_ID $STEP_ID 'bundle config retry 3' -- bundle config retry 3 buildevents cmd $TRACE_ID $STEP_ID 'bundle install' -- bundle install buildevents cmd $TRACE_ID $STEP_ID 'bundle clean' -- bundle clean echo ::group::bundler environment buildevents cmd $TRACE_ID $STEP_ID 'bundle env' -- bundle env echo ::endgroup:: - name: "Honeycomb: Record Bundler Setup time" if: ${{ always() }} run: | buildevents step $TRACE_ID $STEP_ID $STEP_START 'Bundler Setup' echo STEP_ID=${{ matrix.platform }}-${{ matrix.collection }}-3 >> $GITHUB_ENV echo STEP_START=$(date +%s) >> $GITHUB_ENV - name: Provision test environment run: | buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:provision ${{ matrix.platform }}' -- bundle exec rake 'litmus:provision[provision::provision_service,${{ matrix.platform }}]' echo ::group::=== REQUEST === cat request.json || true echo echo ::endgroup:: echo ::group::=== INVENTORY === sed -e 's/password: .*/password: "[redacted]"/' < inventory.yaml || true echo ::endgroup:: # The provision service hands out machines as soon as they're provisioned. # The GCP VMs might still take a while to spool up and configure themselves fully. # This retry loop spins until all agents have been installed successfully. - name: Install agent uses: nick-invision/retry@v1 with: timeout_minutes: 30 max_attempts: 5 retry_wait_seconds: 60 command: buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:install_agent ${{ matrix.collection }}' -- bundle exec rake 'litmus:install_agent[${{ matrix.collection }}]' # The agent installer on windows does not finish in time for this to work. To # work around this for now, retry after a minute if installing the module failed. - name: Install module uses: nick-invision/retry@v1 with: timeout_minutes: 30 max_attempts: 2 retry_wait_seconds: 60 command: buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:install_module' -- bundle exec rake 'litmus:install_module' - name: "Honeycomb: Record deployment times" if: ${{ always() }} run: | echo ::group::honeycomb step buildevents step $TRACE_ID $STEP_ID $STEP_START 'Deploy test system' echo STEP_ID=${{ matrix.platform }}-${{ matrix.collection }}-4 >> $GITHUB_ENV echo STEP_START=$(date +%s) >> $GITHUB_ENV echo ::endgroup:: - name: Run acceptance tests run: | buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:acceptance:parallel' -- bundle exec rake 'litmus:acceptance:parallel' - name: "Honeycomb: Record acceptance testing times" if: ${{ always() }} run: | buildevents step $TRACE_ID $STEP_ID $STEP_START 'Run acceptance tests' echo STEP_ID=${{ matrix.platform }}-${{ matrix.collection }}-5 >> $GITHUB_ENV echo STEP_START=$(date +%s) >> $GITHUB_ENV - name: Remove test environment if: ${{ always() }} run: | if [ -f inventory.yaml ]; then buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:tear_down' -- bundle exec rake 'litmus:tear_down' echo ::group::=== REQUEST === cat request.json || true echo echo ::endgroup:: fi - name: "Honeycomb: Record removal times" if: ${{ always() }} run: | buildevents step $TRACE_ID $STEP_ID $STEP_START 'Remove test environment' slack-workflow-status: if: always() name: Post Workflow Status To Slack needs: - Acceptance runs-on: ubuntu-20.04 steps: - name: Slack Workflow Notification - uses: Gamesight/slack-workflow-status@master + uses: Gamesight/slack-workflow-status@main with: # Required Input repo_token: ${{ secrets.GITHUB_TOKEN }} slack_webhook_url: ${{ secrets.SLACK_WEBHOOK }} # Optional Input channel: '#team-ia-bots' name: 'GABot' diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 064443f..8424781 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -1,65 +1,65 @@ name: "release" on: push: branches: - 'release' jobs: LitmusAcceptancePuppet5: env: HONEYCOMB_WRITEKEY: 7f3c63a70eecc61d635917de46bea4e6 HONEYCOMB_DATASET: litmus tests runs-on: self-hosted strategy: matrix: ruby_version: [2.5.x] puppet_gem_version: [~> 6.0] platform: [release_checks_5] agent_family: ['puppet5'] steps: - uses: actions/checkout@v1 - name: Litmus Parallel - uses: puppetlabs/action-litmus_parallel@master + uses: puppetlabs/action-litmus_parallel@main with: platform: ${{ matrix.platform }} agent_family: ${{ matrix.agent_family }} LitmusAcceptancePuppet6: env: HONEYCOMB_WRITEKEY: 7f3c63a70eecc61d635917de46bea4e6 HONEYCOMB_DATASET: litmus tests runs-on: self-hosted strategy: matrix: ruby_version: [2.5.x] puppet_gem_version: [~> 6.0] platform: [release_checks_6] agent_family: ['puppet6'] steps: - uses: actions/checkout@v1 - name: Litmus Parallel - uses: puppetlabs/action-litmus_parallel@master + uses: puppetlabs/action-litmus_parallel@main with: platform: ${{ matrix.platform }} agent_family: ${{ matrix.agent_family }} Spec: runs-on: self-hosted strategy: matrix: check: [parallel_spec, 'syntax lint metadata_lint check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop'] ruby_version: [2.5.x] puppet_gem_version: [~> 5.0, ~> 6.0] exclude: - puppet_gem_version: ~> 5.0 check: 'syntax lint metadata_lint check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop' - ruby_version: 2.5.x puppet_gem_version: ~> 5.0 steps: - uses: actions/checkout@v1 - name: Spec Tests - uses: puppetlabs/action-litmus_spec@master + uses: puppetlabs/action-litmus_spec@main with: puppet_gem_version: ${{ matrix.puppet_gem_version }} check: ${{ matrix.check }} diff --git a/.github/workflows/weekly.yml b/.github/workflows/weekly.yml index c350cd9..ead85f9 100644 --- a/.github/workflows/weekly.yml +++ b/.github/workflows/weekly.yml @@ -1,64 +1,64 @@ name: "weekly" on: schedule: - cron: '0 1 * * 4' jobs: LitmusAcceptancePuppet5: env: HONEYCOMB_WRITEKEY: 7f3c63a70eecc61d635917de46bea4e6 HONEYCOMB_DATASET: litmus tests runs-on: self-hosted strategy: matrix: ruby_version: [2.5.x] puppet_gem_version: [~> 6.0] platform: [release_checks_5] agent_family: ['puppet5'] steps: - uses: actions/checkout@v1 - name: Litmus Parallel - uses: puppetlabs/action-litmus_parallel@master + uses: puppetlabs/action-litmus_parallel@main with: platform: ${{ matrix.platform }} agent_family: ${{ matrix.agent_family }} LitmusAcceptancePuppet6: env: HONEYCOMB_WRITEKEY: 7f3c63a70eecc61d635917de46bea4e6 HONEYCOMB_DATASET: litmus tests runs-on: self-hosted strategy: matrix: ruby_version: [2.5.x] puppet_gem_version: [~> 6.0] platform: [release_checks_6] agent_family: ['puppet6'] steps: - uses: actions/checkout@v1 - name: Litmus Parallel - uses: puppetlabs/action-litmus_parallel@master + uses: puppetlabs/action-litmus_parallel@main with: platform: ${{ matrix.platform }} agent_family: ${{ matrix.agent_family }} Spec: runs-on: self-hosted strategy: matrix: check: [parallel_spec, 'syntax lint metadata_lint check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop'] ruby_version: [2.5.x] puppet_gem_version: [~> 5.0, ~> 6.0] exclude: - puppet_gem_version: ~> 5.0 check: 'syntax lint metadata_lint check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop' - ruby_version: 2.5.x puppet_gem_version: ~> 5.0 steps: - uses: actions/checkout@v1 - name: Spec Tests - uses: puppetlabs/action-litmus_spec@master + uses: puppetlabs/action-litmus_spec@main with: puppet_gem_version: ${{ matrix.puppet_gem_version }} check: ${{ matrix.check }} diff --git a/CHANGELOG.md b/CHANGELOG.md index e5ea5c1..0c3777e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,1198 +1,1198 @@ # Change log All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org). ## [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-20) [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v6.3.0...v6.4.0) ### Added - pdksync - \(IAC-973\) - Update travis/appveyor to run on new default branch `main` [\#1117](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1117) ([david22swan](https://github.com/david22swan)) - \(IAC-746\) - Add ubuntu 20.04 support [\#1110](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1110) ([david22swan](https://github.com/david22swan)) ### 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-10) [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)) - \(MODULES-8760\) Add iterative feature to merge\(\) function [\#1008](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1008) ([hlindberg](https://github.com/hlindberg)) ### Added - 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-17) [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-09-28) [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)) - Fix `pick` function docs [\#955](https://github.com/puppetlabs/puppetlabs-stdlib/pull/955) ([alexjfisher](https://github.com/alexjfisher)) - \(MODULES-7768\) Handle nil in delete\_undef\_values\(\) function [\#954](https://github.com/puppetlabs/puppetlabs-stdlib/pull/954) ([hlindberg](https://github.com/hlindberg)) - Update docs for 'concat' to be correct [\#950](https://github.com/puppetlabs/puppetlabs-stdlib/pull/950) ([rhowe-gds](https://github.com/rhowe-gds)) ## 5.0.0 ### Summary This is a major release which removes support for the Scientific 5 and Debian 7 OS, as well as a removal of the `Stdlib::(Ipv4|IPv6|Ip_address)` data types in favour of `Stdlib::IP::*`. **In addition it contains a substantial piece of work centered around updating functions that have now been migrated into Puppet itself. Please note that this will be the last major release to support Puppet 2 and Puppet 3 and that they will soon be removed.** #### Fixed - Docs URLs corrected. - Docs clarified that `Stdlib::Unixpath` only matches absolute paths. - `dirname()` now fails when passed an empty string. - `basename()` documentation clarified. - Corrected documentation of `count()` wrt matches and empty string. - Corrected example in `getparam()` and added note about equivalent in puppet. - Fixed URL to use 'latest' instead of '5.5' for `Hash.new` function. #### Added - Support added for symbolic file nodes. - `loadjson()` and `loadyml()` now compatible with HTTPS files. - `loadjson()` and `loadyml()` now compatible with HTTP basic auth files. - `any2array` now returns and empty array when given an empty string. - Support has now been added for Ubuntu 18.04. - `seeded_rand_string()` function has been added. #### Changed - PDK update `1.5.0` has been applied. - `size()` function deprecated for Puppet 6 and above. - `wrt` functions moved to Puppet as of Puppet 6. - `sprintf_hash` has had notification put in place to show that as of Puppet 4.10.10 it's functionality is supported by the puppet core. - Added note that `abs()` is in puppet since 6.0.0. - Added information to `base64` function about Binary data type. - Added note to `camelcase()` that function is now in puppet. - Added note to `capitalize()` that function is now in puppet. - Added note to `ceiling()` that function is now in puppet. - Added note to `chomp()` that function is now in puppet. - Added note to `chop()` that function is now in puppet. - Added note how to do equivalence of `clamp()` function in puppet 6. - Added note that `concat()` can be done with + since puppet 4.0.0. - Added note to `convert_base()` how to do this with puppet core. - Added equivalent puppet core way of doing `count()`. - Added docs for equivalent puppet language for `delete_regexp()`. - Added docs for equivalent language constructs for `delete_at()`. - Added puppet 4 equivalent for `delete_undef()` function. - Added equivalent puppet language for `delete_values()`. - Updated `delete()` function with docs about equivalent language. - Added docs that - between arrays is the same as `difference()`. - Added note to `downcase()` that function is now in puppet. - Added note to `empty()` that function is now in puppet. - Added note to `flatten()` that function is now in puppet. - Added note to `floor()` that function is now in puppet. - Added note to `get_module_path()` that puppet has similar function. - Amended documentation for `getvar()`. - Add note to `grep()` that `filter()` in puppet does the same. - Updated `has_key()` with equivalent puppet lang expresion. - Updated the `hash()` function to show equivalent expression. - Added note about more formatting options with `String()` in puppet. - Added note to `join()` that it is in puppet since 5.4.0. - Added note to `keys()` that it is in puppet since 5.4.0. - Added note to `lstrip()`, `rstrip()`, `strip()` and `upcase()` that they are in puppet since 6.0.0. - Updated `member()` with equivalent language expression example. - Updated `merge()` with puppt language equivalent example. - Updated `min()` and `max()` with note that they are in puppet. - Updated `num2bool()` with information that Boolean can convert. - Updated `prefix()` function with equivalent operation in pupppet. - Updated `range()` with information that Integer can be used. - Updated `reject()` with equivalent filter() call. - Added note to `reverse()` that the `reverse_each()` Puppet function does the same as it. - Added note to `round()` that it has moved to puppet in 6.0.0. - Added note to `size()` that `length()` is in puppet since 5.4.0. - Added note to `sort()` that is has moved to Puppet in 6.0.0. - Updated `str2bool()` with a note that Boolean can handle conversion. - Added note to `strftime()` that it moved to puppet in 4.8.0. - Added note to `suffix()` that the same can be done with `map()`. - Updated `time()` to mention Timespan and Timestamp data types. - Added note to `values_at()` for equivalent slice operation in language. - Added note to `values()` that it moved to puppet in 5.5.0. - Corrected docs for `keys()` - in puppet since 5.5.0. - Added note to `length()` that function moved to puppet. - Updated README.md with deprecations for functions moved to puppet. - Updated documentation of `values_at()`. - Updated README with note from `time()` about data types for time. - Updated README for `strintf_hash()` (supported by builtin sprintf). - Updated README with deprecation of `hash()` function (use data type). - Updated README `suffix` with equiv example for `map`. - Updated README with `reject` equivalent call to `filter`. - Updated README with `range` equiv use of type system + `each`. - Updated README with `prefix` equiv func using `map`. - Updated README for `num2bool` with info about Boolean type. - Updated README `str2bool` with information about `Boolean` equivalent. - Updated README `merge` with info about `+` operator equivalent. - Updated README `member` with equivalent alternative in language. - Updated README `join_keys_to_values` with link to String.new. - Updated README `has_key` shows deprecation in favor of `in`. - Updated README `grep` adds information about `filter`. - Updated README and `getvar.rb` as getvar has moved to puppet. - Updated README for `getparam` to be the same as in function. - Updated README `get_module_path` with info about built in variant. - Updated README `difference` to mention `-` operator equiv. - Updated README `delete` with built-in alternatives. - Updated README `delete_values` with builtin equiv. - Updated README `delete_undef` & `delete_regexp` with builtin equiv. - Updated README `delete_at` with equivalent built-in examples. - Updated README `coun`t to show built-in equiv. - Updated README `convert_base` with built-in equiv. - Updated README `concat` with built-in equiv using + and <<. - Updated README `base_64` with built-in equiv using Binary type. - Skipped tests for `abs` if puppet version < 6.0.0. - Skipped tests for `min` and `max` if puppet version < 6.0.0. - Skipped tests for `floor` if puppet version < 6.0.0. - Skipped tests for `ceiling` if puppet version < 6.0.0. - Skipped tests for `round` if puppet version < 6.0.0. - Skipped tests for `upcase` if puppet version < 6.0.0. - Skipped tests for `downcase` if puppet version < 6.0.0. - Skipped tests for `capitalize` if puppet version < 6.0.0. - Skipped tests for `camelcase` if puppet version < 6.0.0. - Skipped tests for strip functions if puppet version < 6.0.0. - Skipped tests for `chop` and `chomp` if puppet version < 6.0.0. - Skipped tests for `sort` if puppet version < 6.0.0. - Removed extra space in `describe` for `abs` test. - Updated README and `any2array` with built-in equiv Array.new. - Updated README and `any2bool` with built-in equiv Boolean.new. - Updated README and `bool2num` with built-in equiv Numeric.new. - Updated README and `bool2str` with built-in equiv String.new. - Corrected equivalent example for `count`. - Updated README and made mention of `filter` in `delete` a link. - Updated docs and tests for `strftime`. - Updated all acceptance test using Puppet.version. - Change 'puppet' to 'Puppet' in function doc strings. - HTTP type checks are now case insensitive. #### Removed - Support has been removed for `Scientific 5` and `Debian 7` operating systems. - `Stdlib::(Ipv4|IPv6|Ip_address)` have been removed. ## Supported Release 4.25.1 ### Summary This is a patch which includes a roll up of small fixes. In Puppet 5.5.0 `flatten()`, `length(),` `empty(),` `join(),` `keys(),` and `values()` are now built into Puppet. Please note that the Puppet implementation of the functions will take precedence over the functions in 'puppetlabs-stdlib'. #### Fixed - Remove unneeded execute permission from test files. - Puppet 5.5.0 function deprecation [MODULES-6894](https://tickets.puppetlabs.com/browse/MODULES-6894). ## Supported Release 4.25.0 ### Summary This is quite a feature heavy release, it makes this module PDK-compliant for easier maintenance and includes a roll up of maintenance changes. #### Added - PDK conversion [MODULES-6332](https://tickets.puppetlabs.com/browse/MODULES-6332). - Update `join_keys_to_values` with an undef statement. - Type alias `Stdlib::Fqdn` matches paths on a fully qualified domain name. - Type alias `Stdlib::Host` matches a valid host, this can be a valid 'ipv4', 'ipv6' or 'fqdn'. - Type alias `Stdlib::Port` matches a valid TCP/UDP Port number. - Type alias `Stdlib::Filesource` matches paths valid values for the source parameter of the puppet file type. - Type alias `Stdlib::IP::Address` matches any IP address, including both IPv4 and IPv6 addresses, - Type alias `Stdlib::IP::Address::V4` matches any string consisting of a valid IPv4 address, this is extended by 'CIDR' and 'nosubnet'. - Type alias `Stdlib::IP::Address::V6` matches any string consisting of a valid IPv6 address, this is extended by 'Full', 'Alternate' and 'Compressed'. - Type alias `Stdlib::IP::Address::V6::Nosubnet`matches any string consisting of a valid IPv6 address with no subnet, this is extended by 'Full', 'Alternate' and 'Compressed'. - Type alias `Stdlib::Port` matches a valid TCP/UDP Port number this is then extended to 'Privileged' which are ports less than 1024 and 'Unprivileged' which are ports greater than 1024. ## Supported Release 4.24.0 ### Summary This release includes a roll up of minor changes and a new feature which provides the ability to skip undef values `to_json_pretty()`. We have also reverted a change that was previously made and resulted in breaking compatibility with Ruby 1.8.7. #### Added - Ability to skip undef values in `to_json_pretty()`. - Fix type3x function in stdlib ([MODULES-6216](https://tickets.puppet.com/browse/MODULES-6216)) #### Changed - Indentation for `sync.yml` was fixed. - Updated type alias tests and dropped superfluous wrapper classes - Revert to old ruby 1.X style of hash ([MODULES-6139](https://tickets.puppet.com/browse/MODULES-6139)) - `rubocop.yml` not managed by msync ([MODULES-6201](https://tickets.puppet.com/browse/MODULES-6201)) ## Supported Release 4.23.0 ### Summary This release is in order to implement Rubocop changes throughout the module. #### Added - Standard and translated readme's have been updated. - Rubocop has been implemented in the module and a wide variety of changes have been made to the code. - Modulesync changes have been merged into the code. #### Fixed - Minor fix to the readme. ## Supported Release 4.22.0 ### Summary This is a clean release in preparation of putting the module through the rubocop process. #### Added - Support has been added for Debian 9 - 'Stdlib::Mode type' has been added to the module. - A type for 'ensure' has been added to the service resources. - A new function 'sprintf_hash' has been added to allow the use of named references. #### Removed - Support has been removed for: RedHat 4, CentOS 4, OracleLinux 4, Scientific 4, SLES 10 SP4, Windows Server 2003, Windows Server 2003 R2 and Windows 8. #### Fixed - The 'ruby_spec.rb' test file has been altered s that it properly checks results. - Example syntax in 'file_line.rb' has been fixed. ## Supported Release 4.21.0 ### Summary This is a small feature release that includes a revamped, albeit backwards-compatible file_line type. #### Added - `replace_all_matches_not_matching_line` parameter in file_line - additional tests and documentation for file_line #### Removed - duplicate spec test for absolute_path #### Fixed - Unixpath type to allow "/" as valid path - file_line behavior that caused infinite appending of `line` to a file ([MODULES-5651](https://tickets.puppet.com/browse/MODULES-5651)) ## Supported Release 4.20.0 ### Summary This release adds new functions and updated README translations. #### Added - `to_json`, `to_json_pretty`, and `to_yaml` functions - new Japanese README translations #### Fixed - compatibility issue with older versions of Puppet and the `pw_hash` function ([MODULES-5546](https://tickets.puppet.com/browse/MODULES-5546)) #### Removed - support for EOL platform Debian 6 (Squeeze) ## Supported Release 4.19.0 ### Summary This release adds new functions and better documentation/fixes for existing functions with a noteworthy fix for file_line. #### Added - Add validate_domain_name function - Add the round function - Add type for MAC address - Add support for sensitive data type to pw_hash ([MODULES-4908](https://tickets.puppet.com/browse/MODULES-4908)) - Add new function, fact() (FACT-932) #### Fixed - Fixes for the file_line provider ([MODULES-5003](https://tickets.puppet.com/browse/MODULES-5003)) - Add documentation for email functions ([MODULES-5382](https://tickets.puppet.com/browse/MODULES-5382)) - unique function is deprecated for puppet version > 5. (FM-6239) - Fix headers in CHANGELOG.md so that headers render correctly - ensure_packages, converge ensure values 'present' and 'installed' #### Changed - Removes listed support for EOL Ubuntu versions ## Supported Release 4.18.0 ### Summary Small release that reverts the Puppet version requirement lower bound to again include Puppet 2.7+ and bumps the upper bound to now include Puppet 5. #### Fixed - Reverts lower bound of Puppet requirement to 2.7.20 ## Supported Release 4.17.1 ### Summary Small release to address a bug (PUP-7650). Also pushes the Puppet version compatibility to 4.7.0. #### Bugfixes - (MODULES-5095) Workaround for PUP-7650 - (FM-6197) Formatting fixes for file_line resource ## Supported Release 4.17.0 ### Summary This release adds support for internationalization. It also contains Japanese translations for the README, summary and description of the metadata.json and major cleanups in the README. Additional folders have been introduced called locales and readmes where translation files can be found. A number of features and bug fixes are also included in this release. It also adds a new function `glob()` for expanding file lists. Also works around an issue that appeared in puppet 4.6.0 involving types being declared multiple times. #### Features - Addition of POT file / folder structure for i18n. - Addition of Internationalized READMEs. - `glob()` function ### Fixed - Occasional duplicate type definitions when using `defined_with_params()` - `file_line` encoding issue on ruby 1.8 (unsupported) - Huge readme refresh ## Supported Release 4.16.0 ### Summary This release sees a massive update to all unit tests to test UTF8 characters. There are also multiple cleanups in preparation for internationalization. Alongside this, improvements to ipv6 support, a new length function compatible with Puppet 4, and an update to path types. Also contains multiple bug fixes around functionality and tests. #### Features - Addition of coverage in all unit tests for functions, data and resource types for UTF8 for i18n. - All strings within the readme and functions that are split over two lines have been combined in preparation for i18n parser/decorator. - Improvement on the ipv6 support for type - Improves regex to catch some valid (but lesser known) ipv6 strings, mostly those which are a mix of ipv6 strings and embedded ipv6 numbers. - Adds a new parameter `encoding` to allow non UTF-8 files to specify a file encoding. This prevents receiving the error message "invalid byte sequence in UTF-8" when special characters that are not UTF-8 encoded appear in the input stream, such as the copyright symbol. - Addition of the new length function. Returns the length of a given string, array or hash. To eventually replace the deprecated size() function as can handle the new type functionality introduced in Puppet 4. - Permit double slash in absolute/Unix path types. #### Bugfixes -- Fix unsupported data type error with rspec-puppet master. +- 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 (master) (deafe88) + * (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 master (82194ca) + * (#13439) refactor spec helper for compatibility with both puppet 2.7 and server (82194ca) * (#13494) Specify the behavior of zero padded strings (61891bb) ##### 2012-03-29 Puppet Labs - 2.1.3 * (#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 \* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)* diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1a9fb3a..9c171f9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,271 +1,271 @@ # Contributing to Puppet modules So you want to contribute to a Puppet module: Great! Below are some instructions to get you started doing that very thing while setting expectations around code quality as well as a few tips for making the process as easy as possible. ### Table of Contents 1. [Getting Started](#getting-started) 1. [Commit Checklist](#commit-checklist) 1. [Submission](#submission) 1. [More about commits](#more-about-commits) 1. [Testing](#testing) - [Running Tests](#running-tests) - [Writing Tests](#writing-tests) 1. [Get Help](#get-help) ## Getting Started - Fork the module repository on GitHub and clone to your workspace - Make your changes! ## Commit Checklist ### The Basics - [x] my commit is a single logical unit of work - [x] I have checked for unnecessary whitespace with "git diff --check" - [x] my commit does not include commented out code or unneeded files ### The Content - [x] my commit includes tests for the bug I fixed or feature I added - [x] my commit includes appropriate documentation changes if it is introducing a new feature or changing existing functionality - [x] my code passes existing test suites ### The Commit Message - [x] the first line of my commit message includes: - [x] an issue number (if applicable), e.g. "(MODULES-xxxx) This is the first line" - [x] a short description (50 characters is the soft limit, excluding ticket number(s)) - [x] the body of my commit message: - [x] is meaningful - [x] uses the imperative, present tense: "change", not "changed" or "changes" - [x] includes motivation for the change, and contrasts its implementation with the previous behavior ## Submission ### Pre-requisites - Make sure you have a [GitHub account](https://github.com/join) - [Create a ticket](https://tickets.puppet.com/secure/CreateIssue!default.jspa), or [watch the ticket](https://tickets.puppet.com/browse/) you are patching for. ### Push and PR - Push your changes to your fork - [Open a Pull Request](https://help.github.com/articles/creating-a-pull-request-from-a-fork/) against the repository in the puppetlabs organization ## More about commits 1. Make separate commits for logically separate changes. Please break your commits down into logically consistent units which include new or changed tests relevant to the rest of the change. The goal of doing this is to make the diff easier to read for whoever is reviewing your code. In general, the easier your diff is to read, the more likely someone will be happy to review it and get it into the code base. If you are going to refactor a piece of code, please do so as a separate commit from your feature or bug fix changes. We also really appreciate changes that include tests to make sure the bug is not re-introduced, and that the feature is not accidentally broken. Describe the technical detail of the change(s). If your description starts to get too long, that is a good sign that you probably need to split up your commit into more finely grained pieces. Commits which plainly describe the things which help reviewers check the patch and future developers understand the code are much more likely to be merged in with a minimum of bike-shedding or requested changes. Ideally, the commit message would include information, and be in a form suitable for inclusion in the release notes for the version of Puppet that includes them. Please also check that you are not introducing any trailing whitespace or other "whitespace errors". You can do this by running "git diff --check" on your changes before you commit. 2. Sending your patches To submit your changes via a GitHub pull request, we _highly_ recommend that you have them on a topic branch, instead of - directly on "master". + directly on "main". It makes things much easier to keep track of, especially if you decide to work on another thing before your first change is merged in. GitHub has some pretty good [general documentation](http://help.github.com/) on using their site. They also have documentation on [creating pull requests](https://help.github.com/articles/creating-a-pull-request-from-a-fork/). In general, after pushing your topic branch up to your repository on GitHub, you can switch to the branch in the GitHub UI and click "Pull Request" towards the top of the page in order to open a pull request. 3. Update the related JIRA issue. If there is a JIRA issue associated with the change you submitted, then you should update the ticket to include the location of your branch, along with any other commentary you may wish to make. # Testing ## Getting Started Our Puppet modules provide [`Gemfile`](./Gemfile)s, which can tell a Ruby package manager such as [bundler](http://bundler.io/) what Ruby packages, or Gems, are required to build, develop, and test this software. Please make sure you have [bundler installed](http://bundler.io/#getting-started) on your system, and then use it to install all dependencies needed for this project in the project root by running ```shell % bundle install --path .bundle/gems Fetching gem metadata from https://rubygems.org/........ Fetching gem metadata from https://rubygems.org/.. Using rake (10.1.0) Using builder (3.2.2) -- 8><-- many more --><8 -- Using rspec-system-puppet (2.2.0) Using serverspec (0.6.3) Using rspec-system-serverspec (1.0.0) Using bundler (1.3.5) Your bundle is complete! Use `bundle show [gemname]` to see where a bundled gem is installed. ``` NOTE: some systems may require you to run this command with sudo. If you already have those gems installed, make sure they are up-to-date: ```shell % bundle update ``` ## Running Tests With all dependencies in place and up-to-date, run the tests: ### Unit Tests ```shell % bundle exec rake spec ``` This executes all the [rspec tests](http://rspec-puppet.com/) in the directories defined [here](https://github.com/puppetlabs/puppetlabs_spec_helper/blob/699d9fbca1d2489bff1736bb254bb7b7edb32c74/lib/puppetlabs_spec_helper/rake_tasks.rb#L17) and so on. rspec tests may have the same kind of dependencies as the module they are testing. Although the module defines these dependencies in its [metadata.json](./metadata.json), rspec tests define them in [.fixtures.yml](./fixtures.yml). ### Acceptance Tests Some Puppet modules also come with acceptance tests, which use [beaker][]. These tests spin up a virtual machine under [VirtualBox](https://www.virtualbox.org/), controlled with [Vagrant](http://www.vagrantup.com/), to simulate scripted test scenarios. In order to run these, you need both Virtualbox and Vagrant installed on your system. Run the tests by issuing the following command ```shell % bundle exec rake spec_clean % bundle exec rspec spec/acceptance ``` This will now download a pre-fabricated image configured in the [default node-set](./spec/acceptance/nodesets/default.yml), install Puppet, copy this module, and install its dependencies per [spec/spec_helper_acceptance.rb](./spec/spec_helper_acceptance.rb) and then run all the tests under [spec/acceptance](./spec/acceptance). ## Writing Tests ### Unit Tests When writing unit tests for Puppet, [rspec-puppet][] is your best friend. It provides tons of helper methods for testing your manifests against a catalog (e.g. contain_file, contain_package, with_params, etc). It would be ridiculous to try and top rspec-puppet's [documentation][rspec-puppet_docs] but here's a tiny sample: Sample manifest: ```puppet file { "a test file": ensure => present, path => "/etc/sample", } ``` Sample test: ```ruby it 'does a thing' do expect(subject).to contain_file("a test file").with({:path => "/etc/sample"}) end ``` ### Acceptance Tests Writing acceptance tests for Puppet involves [beaker][] and its cousin [beaker-rspec][]. A common pattern for acceptance tests is to create a test manifest, apply it twice to check for idempotency or errors, then run expectations. ```ruby it 'does an end-to-end thing' do pp = <<-EOF file { 'a test file': ensure => present, path => "/etc/sample", content => "test string", } apply_manifest(pp, :catch_failures => true) apply_manifest(pp, :catch_changes => true) end describe file("/etc/sample") do it { is_expected.to contain "test string" } end ``` # If you have commit access to the repository Even if you have commit access to the repository, you still need to go through the process above, and have someone else review and merge in your changes. The rule is that **all changes must be reviewed by a project developer that did not write the code to ensure that all changes go through a code review process.** The record of someone performing the merge is the record that they performed the code review. Again, this should be someone other than the author of the topic branch. # Get Help ### On the web * [Puppet help messageboard](http://puppet.com/community/get-help) * [Writing tests](https://docs.puppet.com/guides/module_guides/bgtm.html#step-three-module-testing) * [General GitHub documentation](http://help.github.com/) * [GitHub pull request documentation](http://help.github.com/send-pull-requests/) ### On chat * Slack (slack.puppet.com) #forge-modules, #puppet-dev, #windows, #voxpupuli * IRC (freenode) #puppet-dev, #voxpupuli [rspec-puppet]: http://rspec-puppet.com/ [rspec-puppet_docs]: http://rspec-puppet.com/documentation/ [beaker]: https://github.com/puppetlabs/beaker [beaker-rspec]: https://github.com/puppetlabs/beaker-rspec diff --git a/HISTORY.md b/HISTORY.md index 1c6663e..015dd1d 100644 --- a/HISTORY.md +++ b/HISTORY.md @@ -1,1067 +1,1067 @@ ## 5.0.0 ### Summary This is a major release which removes support for the Scientific 5 and Debian 7 OS, as well as a removal of the `Stdlib::(Ipv4|IPv6|Ip_address)` data types in favour of `Stdlib::IP::*`. **In addition it contains a substantial piece of work centered around updating functions that have now been migrated into Puppet itself. Please note that this will be the last major release to support Puppet 2 and Puppet 3 and that they will soon be removed.** #### Fixed - Docs URLs corrected. - Docs clarified that `Stdlib::Unixpath` only matches absolute paths. - `dirname()` now fails when passed an empty string. - `basename()` documentation clarified. - Corrected documentation of `count()` wrt matches and empty string. - Corrected example in `getparam()` and added note about equivalent in puppet. - Fixed URL to use 'latest' instead of '5.5' for `Hash.new` function. #### Added - Support added for symbolic file nodes. - `loadjson()` and `loadyml()` now compatible with HTTPS files. - `loadjson()` and `loadyml()` now compatible with HTTP basic auth files. - `any2array` now returns and empty array when given an empty string. - Support has now been added for Ubuntu 18.04. - `seeded_rand_string()` function has been added. #### Changed - PDK update `1.5.0` has been applied. - `size()` function deprecated for Puppet 6 and above. - `wrt` functions moved to Puppet as of Puppet 6. - `sprintf_hash` has had notification put in place to show that as of Puppet 4.10.10 it's functionality is supported by the puppet core. - Added note that `abs()` is in puppet since 6.0.0. - Added information to `base64` function about Binary data type. - Added note to `camelcase()` that function is now in puppet. - Added note to `capitalize()` that function is now in puppet. - Added note to `ceiling()` that function is now in puppet. - Added note to `chomp()` that function is now in puppet. - Added note to `chop()` that function is now in puppet. - Added note how to do equivalence of `clamp()` function in puppet 6. - Added note that `concat()` can be done with + since puppet 4.0.0. - Added note to `convert_base()` how to do this with puppet core. - Added equivalent puppet core way of doing `count()`. - Added docs for equivalent puppet language for `delete_regexp()`. - Added docs for equivalent language constructs for `delete_at()`. - Added puppet 4 equivalent for `delete_undef()` function. - Added equivalent puppet language for `delete_values()`. - Updated `delete()` function with docs about equivalent language. - Added docs that - between arrays is the same as `difference()`. - Added note to `downcase()` that function is now in puppet. - Added note to `empty()` that function is now in puppet. - Added note to `flatten()` that function is now in puppet. - Added note to `floor()` that function is now in puppet. - Added note to `get_module_path()` that puppet has similar function. - Amended documentation for `getvar()`. - Add note to `grep()` that `filter()` in puppet does the same. - Updated `has_key()` with equivalent puppet lang expresion. - Updated the `hash()` function to show equivalent expression. - Added note about more formatting options with `String()` in puppet. - Added note to `join()` that it is in puppet since 5.4.0. - Added note to `keys()` that it is in puppet since 5.4.0. - Added note to `lstrip()`, `rstrip()`, `strip()` and `upcase()` that they are in puppet since 6.0.0. - Updated `member()` with equivalent language expression example. - Updated `merge()` with puppt language equivalent example. - Updated `min()` and `max()` with note that they are in puppet. - Updated `num2bool()` with information that Boolean can convert. - Updated `prefix()` function with equivalent operation in pupppet. - Updated `range()` with information that Integer can be used. - Updated `reject()` with equivalent filter() call. - Added note to `reverse()` that the `reverse_each()` Puppet function does the same as it. - Added note to `round()` that it has moved to puppet in 6.0.0. - Added note to `size()` that `length()` is in puppet since 5.4.0. - Added note to `sort()` that is has moved to Puppet in 6.0.0. - Updated `str2bool()` with a note that Boolean can handle conversion. - Added note to `strftime()` that it moved to puppet in 4.8.0. - Added note to `suffix()` that the same can be done with `map()`. - Updated `time()` to mention Timespan and Timestamp data types. - Added note to `values_at()` for equivalent slice operation in language. - Added note to `values()` that it moved to puppet in 5.5.0. - Corrected docs for `keys()` - in puppet since 5.5.0. - Added note to `length()` that function moved to puppet. - Updated README.md with deprecations for functions moved to puppet. - Updated documentation of `values_at()`. - Updated README with note from `time()` about data types for time. - Updated README for `strintf_hash()` (supported by builtin sprintf). - Updated README with deprecation of `hash()` function (use data type). - Updated README `suffix` with equiv example for `map`. - Updated README with `reject` equivalent call to `filter`. - Updated README with `range` equiv use of type system + `each`. - Updated README with `prefix` equiv func using `map`. - Updated README for `num2bool` with info about Boolean type. - Updated README `str2bool` with information about `Boolean` equivalent. - Updated README `merge` with info about `+` operator equivalent. - Updated README `member` with equivalent alternative in language. - Updated README `join_keys_to_values` with link to String.new. - Updated README `has_key` shows deprecation in favor of `in`. - Updated README `grep` adds information about `filter`. - Updated README and `getvar.rb` as getvar has moved to puppet. - Updated README for `getparam` to be the same as in function. - Updated README `get_module_path` with info about built in variant. - Updated README `difference` to mention `-` operator equiv. - Updated README `delete` with built-in alternatives. - Updated README `delete_values` with builtin equiv. - Updated README `delete_undef` & `delete_regexp` with builtin equiv. - Updated README `delete_at` with equivalent built-in examples. - Updated README `coun`t to show built-in equiv. - Updated README `convert_base` with built-in equiv. - Updated README `concat` with built-in equiv using + and <<. - Updated README `base_64` with built-in equiv using Binary type. - Skipped tests for `abs` if puppet version < 6.0.0. - Skipped tests for `min` and `max` if puppet version < 6.0.0. - Skipped tests for `floor` if puppet version < 6.0.0. - Skipped tests for `ceiling` if puppet version < 6.0.0. - Skipped tests for `round` if puppet version < 6.0.0. - Skipped tests for `upcase` if puppet version < 6.0.0. - Skipped tests for `downcase` if puppet version < 6.0.0. - Skipped tests for `capitalize` if puppet version < 6.0.0. - Skipped tests for `camelcase` if puppet version < 6.0.0. - Skipped tests for strip functions if puppet version < 6.0.0. - Skipped tests for `chop` and `chomp` if puppet version < 6.0.0. - Skipped tests for `sort` if puppet version < 6.0.0. - Removed extra space in `describe` for `abs` test. - Updated README and `any2array` with built-in equiv Array.new. - Updated README and `any2bool` with built-in equiv Boolean.new. - Updated README and `bool2num` with built-in equiv Numeric.new. - Updated README and `bool2str` with built-in equiv String.new. - Corrected equivalent example for `count`. - Updated README and made mention of `filter` in `delete` a link. - Updated docs and tests for `strftime`. - Updated all acceptance test using Puppet.version. - Change 'puppet' to 'Puppet' in function doc strings. - HTTP type checks are now case insensitive. #### Removed - Support has been removed for `Scientific 5` and `Debian 7` operating systems. - `Stdlib::(Ipv4|IPv6|Ip_address)` have been removed. ## Supported Release 4.25.1 ### Summary This is a patch which includes a roll up of small fixes. In Puppet 5.5.0 `flatten()`, `length(),` `empty(),` `join(),` `keys(),` and `values()` are now built into Puppet. Please note that the Puppet implementation of the functions will take precedence over the functions in 'puppetlabs-stdlib'. #### Fixed - Remove unneeded execute permission from test files. - Puppet 5.5.0 function deprecation [MODULES-6894](https://tickets.puppetlabs.com/browse/MODULES-6894). ## Supported Release 4.25.0 ### Summary This is quite a feature heavy release, it makes this module PDK-compliant for easier maintenance and includes a roll up of maintenance changes. #### Added - PDK conversion [MODULES-6332](https://tickets.puppetlabs.com/browse/MODULES-6332). - Update `join_keys_to_values` with an undef statement. - Type alias `Stdlib::Fqdn` matches paths on a fully qualified domain name. - Type alias `Stdlib::Host` matches a valid host, this can be a valid 'ipv4', 'ipv6' or 'fqdn'. - Type alias `Stdlib::Port` matches a valid TCP/UDP Port number. - Type alias `Stdlib::Filesource` matches paths valid values for the source parameter of the puppet file type. - Type alias `Stdlib::IP::Address` matches any IP address, including both IPv4 and IPv6 addresses, - Type alias `Stdlib::IP::Address::V4` matches any string consisting of a valid IPv4 address, this is extended by 'CIDR' and 'nosubnet'. - Type alias `Stdlib::IP::Address::V6` matches any string consisting of a valid IPv6 address, this is extended by 'Full', 'Alternate' and 'Compressed'. - Type alias `Stdlib::IP::Address::V6::Nosubnet`matches any string consisting of a valid IPv6 address with no subnet, this is extended by 'Full', 'Alternate' and 'Compressed'. - Type alias `Stdlib::Port` matches a valid TCP/UDP Port number this is then extended to 'Privileged' which are ports less than 1024 and 'Unprivileged' which are ports greater than 1024. ## Supported Release 4.24.0 ### Summary This release includes a roll up of minor changes and a new feature which provides the ability to skip undef values `to_json_pretty()`. We have also reverted a change that was previously made and resulted in breaking compatibility with Ruby 1.8.7. #### Added - Ability to skip undef values in `to_json_pretty()`. - Fix type3x function in stdlib ([MODULES-6216](https://tickets.puppet.com/browse/MODULES-6216)) #### Changed - Indentation for `sync.yml` was fixed. - Updated type alias tests and dropped superfluous wrapper classes - Revert to old ruby 1.X style of hash ([MODULES-6139](https://tickets.puppet.com/browse/MODULES-6139)) - `rubocop.yml` not managed by msync ([MODULES-6201](https://tickets.puppet.com/browse/MODULES-6201)) ## Supported Release 4.23.0 ### Summary This release is in order to implement Rubocop changes throughout the module. #### Added - Standard and translated readme's have been updated. - Rubocop has been implemented in the module and a wide variety of changes have been made to the code. - Modulesync changes have been merged into the code. #### Fixed - Minor fix to the readme. ## Supported Release 4.22.0 ### Summary This is a clean release in preparation of putting the module through the rubocop process. #### Added - Support has been added for Debian 9 - 'Stdlib::Mode type' has been added to the module. - A type for 'ensure' has been added to the service resources. - A new function 'sprintf_hash' has been added to allow the use of named references. #### Removed - Support has been removed for: RedHat 4, CentOS 4, OracleLinux 4, Scientific 4, SLES 10 SP4, Windows Server 2003, Windows Server 2003 R2 and Windows 8. #### Fixed - The 'ruby_spec.rb' test file has been altered s that it properly checks results. - Example syntax in 'file_line.rb' has been fixed. ## Supported Release 4.21.0 ### Summary This is a small feature release that includes a revamped, albeit backwards-compatible file_line type. #### Added - `replace_all_matches_not_matching_line` parameter in file_line - additional tests and documentation for file_line #### Removed - duplicate spec test for absolute_path #### Fixed - Unixpath type to allow "/" as valid path - file_line behavior that caused infinite appending of `line` to a file ([MODULES-5651](https://tickets.puppet.com/browse/MODULES-5651)) ## Supported Release 4.20.0 ### Summary This release adds new functions and updated README translations. #### Added - `to_json`, `to_json_pretty`, and `to_yaml` functions - new Japanese README translations #### Fixed - compatibility issue with older versions of Puppet and the `pw_hash` function ([MODULES-5546](https://tickets.puppet.com/browse/MODULES-5546)) #### Removed - support for EOL platform Debian 6 (Squeeze) ## Supported Release 4.19.0 ### Summary This release adds new functions and better documentation/fixes for existing functions with a noteworthy fix for file_line. #### Added - Add validate_domain_name function - Add the round function - Add type for MAC address - Add support for sensitive data type to pw_hash ([MODULES-4908](https://tickets.puppet.com/browse/MODULES-4908)) - Add new function, fact() (FACT-932) #### Fixed - Fixes for the file_line provider ([MODULES-5003](https://tickets.puppet.com/browse/MODULES-5003)) - Add documentation for email functions ([MODULES-5382](https://tickets.puppet.com/browse/MODULES-5382)) - unique function is deprecated for puppet version > 5. (FM-6239) - Fix headers in CHANGELOG.md so that headers render correctly - ensure_packages, converge ensure values 'present' and 'installed' #### Changed - Removes listed support for EOL Ubuntu versions ## Supported Release 4.18.0 ### Summary Small release that reverts the Puppet version requirement lower bound to again include Puppet 2.7+ and bumps the upper bound to now include Puppet 5. #### Fixed - Reverts lower bound of Puppet requirement to 2.7.20 ## Supported Release 4.17.1 ### Summary Small release to address a bug (PUP-7650). Also pushes the Puppet version compatibility to 4.7.0. #### Bugfixes - (MODULES-5095) Workaround for PUP-7650 - (FM-6197) Formatting fixes for file_line resource ## Supported Release 4.17.0 ### Summary This release adds support for internationalization. It also contains Japanese translations for the README, summary and description of the metadata.json and major cleanups in the README. Additional folders have been introduced called locales and readmes where translation files can be found. A number of features and bug fixes are also included in this release. It also adds a new function `glob()` for expanding file lists. Also works around an issue that appeared in puppet 4.6.0 involving types being declared multiple times. #### Features - Addition of POT file / folder structure for i18n. - Addition of Internationalized READMEs. - `glob()` function ### Fixed - Occasional duplicate type definitions when using `defined_with_params()` - `file_line` encoding issue on ruby 1.8 (unsupported) - Huge readme refresh ## Supported Release 4.16.0 ### Summary This release sees a massive update to all unit tests to test UTF8 characters. There are also multiple cleanups in preparation for internationalization. Alongside this, improvements to ipv6 support, a new length function compatible with Puppet 4, and an update to path types. Also contains multiple bug fixes around functionality and tests. #### Features - Addition of coverage in all unit tests for functions, data and resource types for UTF8 for i18n. - All strings within the readme and functions that are split over two lines have been combined in preparation for i18n parser/decorator. - Improvement on the ipv6 support for type - Improves regex to catch some valid (but lesser known) ipv6 strings, mostly those which are a mix of ipv6 strings and embedded ipv6 numbers. - Adds a new parameter `encoding` to allow non UTF-8 files to specify a file encoding. This prevents receiving the error message "invalid byte sequence in UTF-8" when special characters that are not UTF-8 encoded appear in the input stream, such as the copyright symbol. - Addition of the new length function. Returns the length of a given string, array or hash. To eventually replace the deprecated size() function as can handle the new type functionality introduced in Puppet 4. - Permit double slash in absolute/Unix path types. #### Bugfixes -- Fix unsupported data type error with rspec-puppet master. +- 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 (master) (deafe88) + * (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 master (82194ca) + * (#13439) refactor spec helper for compatibility with both puppet 2.7 and server (82194ca) * (#13494) Specify the behavior of zero padded strings (61891bb) ##### 2012-03-29 Puppet Labs - 2.1.3 * (#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/README.md b/README.md index f21f34f..7db01ec 100644 --- a/README.md +++ b/README.md @@ -1,574 +1,574 @@ # 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. [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. The only other class currently included in the module is `stdlib::stages`. The `stdlib::stages` class declares various run stages for deploying infrastructure, language runtimes, and application layers. The high level stages are (in order): * setup * main * runtime * setup_infra * deploy_infra * setup_app * deploy_app * deploy Sample usage: ```puppet node default { include stdlib class { java: stage => 'runtime' } } ``` ## Reference -For information on the classes and types, see the [REFERENCE.md](https://github.com/puppetlabs/puppetlabs-stdlib/blob/master/REFERENCE.md). +For information on the classes and types, see the [REFERENCE.md](https://github.com/puppetlabs/puppetlabs-stdlib/blob/main/REFERENCE.md). ### Data types #### `Stdlib::Absolutepath` A strict absolute path type. Uses a variant of Unixpath and Windowspath types. Acceptable input examples: ```shell /var/log ``` ```shell /usr2/username/bin:/usr/local/bin:/usr/bin:. ``` ```shell C:\\WINDOWS\\System32 ``` Unacceptable input example: ```shell ../relative_path ``` #### `Stdlib::Ensure::Service` Matches acceptable ensure values for service resources. Acceptable input examples: ```shell stopped running ``` Unacceptable input example: ```shell true false ``` #### `Stdlib::HTTPSUrl` Matches HTTPS URLs. It is a case insensitive match. Acceptable input example: ```shell https://hello.com HTTPS://HELLO.COM ``` Unacceptable input example: ```shell httds://notquiteright.org` ``` #### `Stdlib::HTTPUrl` Matches both HTTPS and HTTP URLs. It is a case insensitive match. Acceptable input example: ```shell https://hello.com http://hello.com HTTP://HELLO.COM ``` Unacceptable input example: ```shell httds://notquiteright.org ``` #### `Stdlib::MAC` Matches MAC addresses defined in [RFC5342](https://tools.ietf.org/html/rfc5342). #### `Stdlib::Unixpath` Matches absolute paths on Unix operating systems. Acceptable input example: ```shell /usr2/username/bin:/usr/local/bin:/usr/bin: /var/tmp ``` Unacceptable input example: ```shell C:/whatever some/path ../some/other/path ``` #### `Stdlib::Filemode` Matches octal file modes consisting of one to four numbers and symbolic file modes. Acceptable input examples: ```shell 0644 ``` ```shell 1777 ``` ```shell a=Xr,g=w ``` Unacceptable input examples: ```shell x=r,a=wx ``` ```shell 0999 ``` #### `Stdlib::Windowspath` Matches paths on Windows operating systems. Acceptable input example: ```shell C:\\WINDOWS\\System32 C:\\ \\\\host\\windows ``` Valid values: A windows filepath. #### `Stdlib::Filesource` Matches paths valid values for the source parameter of the Puppet file type. Acceptable input example: ```shell http://example.com https://example.com file:///hello/bla ``` Valid values: A filepath. #### `Stdlib::Fqdn` Matches paths on fully qualified domain name. Acceptable input example: ```shell localhost example.com www.example.com ``` Valid values: Domain name of a server. #### `Stdlib::Host` Matches a valid host which could be a valid ipv4, ipv6 or fqdn. Acceptable input example: ```shell localhost www.example.com 192.0.2.1 ``` Valid values: An IP address or domain name. #### `Stdlib::Port` Matches a valid TCP/UDP Port number. Acceptable input examples: ```shell 80 443 65000 ``` Valid values: An Integer. #### `Stdlib::Port::Privileged` Matches a valid TCP/UDP Privileged port i.e. < 1024. Acceptable input examples: ```shell 80 443 1023 ``` Valid values: A number less than 1024. #### `Stdlib::Port::Unprivileged` Matches a valid TCP/UDP Privileged port i.e. >= 1024. Acceptable input examples: ```shell 1024 1337 65000 ``` Valid values: A number more than or equal to 1024. #### `Stdlib::Base32` Matches paths a valid base32 string. Acceptable input example: ```shell ASDASDDASD3453453 asdasddasd3453453= ASDASDDASD3453453== ``` Valid values: A base32 string. #### `Stdlib::Base64` Matches paths a valid base64 string. Acceptable input example: ```shell asdasdASDSADA342386832/746+= asdasdASDSADA34238683274/6+ asdasdASDSADA3423868327/46+== ``` Valid values: A base64 string. #### `Stdlib::Ipv4` This type is no longer available. To make use of this functionality, use [Stdlib::IP::Address::V4](https://github.com/puppetlabs/puppetlabs-stdlib#stdlibipaddressv4). #### `Stdlib::Ipv6` This type is no longer available. To make use of this functionality, use [Stdlib::IP::Address::V6](https://github.com/puppetlabs/puppetlabs-stdlib#stdlibipaddressv6). #### `Stdlib::Ip_address` This type is no longer available. To make use of this functionality, use [Stdlib::IP::Address](https://github.com/puppetlabs/puppetlabs-stdlib#stdlibipaddress) #### `Stdlib::IP::Address` Matches any IP address, including both IPv4 and IPv6 addresses. It will match them either with or without an address prefix as used in CIDR format IPv4 addresses. Examples: ``` '127.0.0.1' =~ Stdlib::IP::Address # true '10.1.240.4/24' =~ Stdlib::IP::Address # true '52.10.10.141' =~ Stdlib::IP::Address # true '192.168.1' =~ Stdlib::IP::Address # false 'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210' =~ Stdlib::IP::Address # true 'FF01:0:0:0:0:0:0:101' =~ Stdlib::IP::Address # true ``` #### `Stdlib::IP::Address::V4` Match any string consisting of an IPv4 address in the quad-dotted decimal format, with or without a CIDR prefix. It will not match any abbreviated form (for example, 192.168.1) because these are poorly documented and inconsistently supported. Examples: ``` '127.0.0.1' =~ Stdlib::IP::Address::V4 # true '10.1.240.4/24' =~ Stdlib::IP::Address::V4 # true '192.168.1' =~ Stdlib::IP::Address::V4 # false 'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210' =~ Stdlib::IP::Address::V4 # false '12AB::CD30:192.168.0.1' =~ Stdlib::IP::Address::V4 # false ``` Valid values: An IPv4 address. #### `Stdlib::IP::Address::V6` Match any string consistenting of an IPv6 address in any of the documented formats in RFC 2373, with or without an address prefix. Examples: ``` '127.0.0.1' =~ Stdlib::IP::Address::V6 # false '10.1.240.4/24' =~ Stdlib::IP::Address::V6 # false 'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210' =~ Stdlib::IP::Address::V6 # true 'FF01:0:0:0:0:0:0:101' =~ Stdlib::IP::Address::V6 # true 'FF01::101' =~ Stdlib::IP::Address::V6 # true ``` Valid values: An IPv6 address. #### `Stdlib::IP::Address::Nosubnet` Match the same things as the `Stdlib::IP::Address` alias, except it will not match an address that includes an address prefix (for example, it will match '192.168.0.6' but not '192.168.0.6/24'). Valid values: An IP address with no subnet. #### `Stdlib::IP::Address::V4::CIDR` Match an IPv4 address in the CIDR format. It will only match if the address contains an address prefix (for example, it will match '192.168.0.6/24' but not '192.168.0.6'). Valid values: An IPv4 address with a CIDR provided eg: '192.186.8.101/105'. This will match anything inclusive of '192.186.8.101' to '192.168.8.105'. #### `Stdlib::IP::Address::V4::Nosubnet` Match an IPv4 address only if the address does not contain an address prefix (for example, it will match '192.168.0.6' but not '192.168.0.6/24'). Valid values: An IPv4 address with no subnet. #### `Stdlib::IP::Address::V6::Full` Match an IPv6 address formatted in the "preferred form" as documented in section 2.2 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt), with or without an address prefix as documented in section 2.3 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). #### `Stdlib::IP::Address::V6::Alternate` Match an IPv6 address formatted in the "alternative form" allowing for representing the last two 16-bit pieces of the address with a quad-dotted decimal, as documented in section 2.2.1 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). It will match addresses with or without an address prefix as documented in section 2.3 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). #### `Stdlib::IP::Address::V6::Compressed` Match an IPv6 address which may contain `::` used to compress zeros as documented in section 2.2.2 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). It will match addresses with or without an address prefix as documented in section 2.3 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). #### `Stdlib::IP::Address::V6::Nosubnet` Alias to allow `Stdlib::IP::Address::V6::Nosubnet::Full`, `Stdlib::IP::Address::V6::Nosubnet::Alternate` and `Stdlib::IP::Address::V6::Nosubnet::Compressed`. #### `Stdlib::IP::Address::V6::Nosubnet::Full` Match an IPv6 address formatted in the "preferred form" as documented in section 2.2 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). It will not match addresses with address prefix as documented in section 2.3 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). #### `Stdlib::IP::Address::V6::Nosubnet::Alternate` Match an IPv6 address formatted in the "alternative form" allowing for representing the last two 16-bit pieces of the address with a quad-dotted decimal, as documented in section 2.2.1 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). It will only match addresses without an address prefix as documented in section 2.3 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). #### `Stdlib::IP::Address::V6::Nosubnet::Compressed` Match an IPv6 address which may contain `::` used to compress zeros as documented in section 2.2.2 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). It will only match addresses without an address prefix as documented in section 2.3 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). #### `Stdlib::IP::Address::V6::CIDR` Match an IPv6 address in the CIDR format. It will only match if the address contains an address prefix (for example, it will match 'FF01:0:0:0:0:0:0:101/32', 'FF01::101/60', '::/0', but not 'FF01:0:0:0:0:0:0:101', 'FF01::101', '::'). #### `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 master with which the agent should communicate. +Returns the Puppet agent's `server` value, which is the hostname of the Puppet server with which the agent should communicate. #### `root_home` 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/master/metadata.json) +For an extensive list of supported operating systems, see [metadata.json](https://github.com/puppetlabs/puppetlabs-stdlib/blob/main/metadata.json) ## Development -Puppet modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. We can’t access the huge number of platforms and myriad hardware, software, and deployment configurations that Puppet is intended to serve. We want to keep it as easy as possible to contribute changes so that our modules work in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things. For more information, see our [module contribution guide](https://github.com/puppetlabs/puppetlabs-stdlib/blob/master/CONTRIBUTING.md). +Puppet modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. We can’t access the huge number of platforms and myriad hardware, software, and deployment configurations that Puppet is intended to serve. We want to keep it as easy as possible to contribute changes so that our modules work in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things. For more information, see our [module contribution guide](https://github.com/puppetlabs/puppetlabs-stdlib/blob/main/CONTRIBUTING.md). To report or research a bug with any part of this module, please go to [http://tickets.puppetlabs.com/browse/MODULES](http://tickets.puppetlabs.com/browse/MODULES). ## Contributors The list of contributors can be found at: [https://github.com/puppetlabs/puppetlabs-stdlib/graphs/contributors](https://github.com/puppetlabs/puppetlabs-stdlib/graphs/contributors). diff --git a/REFERENCE.md b/REFERENCE.md index 04a725c..1ede5d9 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -1,7243 +1,7243 @@ # Reference ## Table of Contents ### Classes * [`stdlib`](#stdlib): This module manages stdlib. * [`stdlib::stages`](#stdlibstages): This class manages a standard set of run stages for Puppet. It is managed by the stdlib class, and should not be declared independently. ### Resource types * [`anchor`](#anchor): A simple resource type intended to be used as an anchor in a composite class. * [`file_line`](#file_line): Ensures that a given line is contained within a file. ### Functions * [`abs`](#abs): **Deprecated:** Returns the absolute value of a number * [`any2array`](#any2array): This converts any object to an array containing that object. * [`any2bool`](#any2bool): Converts 'anything' to a boolean. * [`assert_private`](#assert_private): Sets the current class or definition as private. * [`base64`](#base64): Base64 encode or decode a string based on the command and the string submitted * [`basename`](#basename): Strips directory (and optional suffix) from a filename * [`bool2num`](#bool2num): Converts a boolean to a number. * [`bool2str`](#bool2str): Converts a boolean to a string using optionally supplied arguments. * [`camelcase`](#camelcase): **Deprecated** Converts the case of a string or all strings in an array to camel case. * [`capitalize`](#capitalize): **Deprecated** Capitalizes the first letter of a string or array of strings. * [`ceiling`](#ceiling): **Deprecated** Returns the smallest integer greater or equal to the argument. * [`chomp`](#chomp): **Deprecated** Removes the record separator from the end of a string or an array of strings. * [`chop`](#chop): **Deprecated** Returns a new string with the last character removed. * [`clamp`](#clamp): Keeps value within the range [Min, X, Max] by sort based on integer value (parameter order doesn't matter). * [`concat`](#concat): Appends the contents of multiple arrays into array 1. * [`convert_base`](#convert_base): Converts a given integer or base 10 string representing an integer to a specified base, as a string. * [`count`](#count): 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. The uniqueness key - can appear once. The msg is the message te * [`deprecation`](#deprecation): Function to print deprecation warnings (this is the 3.X version of it). * [`difference`](#difference): This function returns the difference between two arrays. * [`dig`](#dig): **DEPRECATED** Retrieves a value within multiple layers of hashes and arrays via an array of keys containing a path. * [`dig44`](#dig44): **DEPRECATED**: Looks up into a complex structure of arrays and hashes and returns a value or the default value if nothing was found. * [`dirname`](#dirname): Returns the dirname of a path. * [`dos2unix`](#dos2unix): Returns the Unix version of the given string. * [`downcase`](#downcase): **Deprecated:** Converts the case of a string or all strings in an array to lower case. * [`empty`](#empty): **Deprecated:** Returns true if the variable is empty. * [`enclose_ipv6`](#enclose_ipv6): Takes an array of ip addresses and encloses the ipv6 addresses with square brackets. * [`ensure_packages`](#ensure_packages): Takes a list of packages and only installs them if they don't already exist. * [`ensure_resource`](#ensure_resource): Takes a resource type, title, and a list of attributes that describe a resource. * [`ensure_resources`](#ensure_resources): Takes a resource type, title (only hash), and a list of attributes that describe a resource. * [`fact`](#fact): Digs into the facts hash using dot-notation * [`flatten`](#flatten): This function flattens any deeply nested arrays and returns a single flat array as a result. * [`floor`](#floor): Returns the largest integer less or equal to the argument. * [`fqdn_rand_string`](#fqdn_rand_string): Generates a random alphanumeric string. Combining the `$fqdn` fact and an optional seed for repeatable randomness. * [`fqdn_rotate`](#fqdn_rotate): Rotates an array or string a random number of times, combining the `$fqdn` fact and an optional seed for repeatable randomness. * [`fqdn_uuid`](#fqdn_uuid): Returns a [RFC 4122](https://tools.ietf.org/html/rfc4122) valid version 5 UUID based on an FQDN string under the DNS namespace * [`get_module_path`](#get_module_path): Returns the absolute path of the specified module for the current environment. * [`getparam`](#getparam): Returns the value of a resource's parameter. * [`getvar`](#getvar): Lookup a variable in a given namespace. * [`glob`](#glob): Uses same patterns as Dir#glob. * [`grep`](#grep): This function searches through an array and returns any elements that match the provided regular expression. * [`has_interface_with`](#has_interface_with): Returns boolean based on kind and value. * [`has_ip_address`](#has_ip_address): Returns true if the client has the requested IP address on some interface. * [`has_ip_network`](#has_ip_network): Returns true if the client has an IP address within the requested network. * [`has_key`](#has_key): **Deprecated:** Determine if a hash has a certain key value. * [`hash`](#hash): **Deprecated:** This function converts an array into a hash. * [`intersection`](#intersection): This function returns an array of the intersection of two. * [`is_a`](#is_a): Boolean check to determine whether a variable is of a given data type. This is equivalent to the `=~` type checks. * [`is_absolute_path`](#is_absolute_path): Wrapper that calls the Puppet 3.x function of the same name. * [`is_absolute_path`](#is_absolute_path): **Deprecated:** Returns boolean true if the string represents an absolute path in the filesystem. * [`is_array`](#is_array): Wrapper that calls the Puppet 3.x function of the same name. * [`is_array`](#is_array): **Deprecated:** Returns true if the variable passed to this function is an array. * [`is_bool`](#is_bool): Wrapper that calls the Puppet 3.x function of the same name. * [`is_bool`](#is_bool): **Deprecated:** Returns true if the variable passed to this function is a boolean. * [`is_domain_name`](#is_domain_name): **Deprecated:** Returns true if the string passed to this function is a syntactically correct domain name. * [`is_email_address`](#is_email_address): **Deprecated:** Returns true if the string passed to this function is a valid email address. * [`is_float`](#is_float): **Deprecated:** Returns true if the variable passed to this function is a float. * [`is_float`](#is_float): Wrapper that calls the Puppet 3.x function of the same name. * [`is_function_available`](#is_function_available): **Deprecated:** Determines whether the Puppet runtime has access to a function by that name. * [`is_hash`](#is_hash): **Deprecated:** Returns true if the variable passed to this function is a hash. * [`is_integer`](#is_integer): **Deprecated:** Returns true if the variable passed to this function is an Integer or a decimal (base 10) integer in String form. * [`is_ip_address`](#is_ip_address): Wrapper that calls the Puppet 3.x function of the same name. * [`is_ip_address`](#is_ip_address): **Deprecated:** Returns true if the string passed to this function is a valid IP address. * [`is_ipv4_address`](#is_ipv4_address): Wrapper that calls the Puppet 3.x function of the same name. * [`is_ipv4_address`](#is_ipv4_address): **Deprecated:** Returns true if the string passed to this function is a valid IPv4 address. * [`is_ipv6_address`](#is_ipv6_address): Wrapper that calls the Puppet 3.x function of the same name. * [`is_ipv6_address`](#is_ipv6_address): **Deprecated:** Returns true if the string passed to this function is a valid IPv6 address. * [`is_mac_address`](#is_mac_address): **Deprecated:** Returns true if the string passed to this function is a valid mac address. * [`is_numeric`](#is_numeric): **Deprecated:** Returns true if the given value is numeric. * [`is_numeric`](#is_numeric): Wrapper that calls the Puppet 3.x function of the same name. * [`is_string`](#is_string): Wrapper that calls the Puppet 3.x function of the same name. * [`is_string`](#is_string): **Deprecated:** Returns true if the variable passed to this function is a string. * [`join`](#join): **Deprecated:** This function joins an array into a string using a separator. * [`join_keys_to_values`](#join_keys_to_values): This function joins each key of a hash to that key's corresponding value with a separator. * [`keys`](#keys): **Deprecated:** Returns the keys of a hash as an array. * [`length`](#length): **Deprecated:** A function to eventually replace the old size() function for stdlib * [`load_module_metadata`](#load_module_metadata): This function loads the metadata of a given module. * [`loadjson`](#loadjson): Load a JSON file containing an array, string, or hash, and return the data in the corresponding native data type. * [`loadyaml`](#loadyaml): Load a YAML file containing an array, string, or hash, and return the data in the corresponding native data type. * [`lstrip`](#lstrip): **Deprecated:** Strips leading spaces to the left of a string. * [`max`](#max): **Deprecated:** Returns the highest value of all arguments. * [`member`](#member): This function determines if a variable is a member of an array. * [`merge`](#merge): Merges two or more hashes together and returns the resulting hash. * [`merge`](#merge): Merges two or more hashes together or hashes resulting from iteration, and returns the resulting hash. * [`min`](#min): **Deprecated:** Returns the lowest value of all arguments. * [`num2bool`](#num2bool): This function converts a number or a string representation of a number into a true boolean. * [`os_version_gte`](#os_version_gte): Checks if the OS version is at least a certain version. * [`parsehocon`](#parsehocon): This function accepts HOCON as a string and converts it into the correct Puppet structure * [`parsejson`](#parsejson): This function accepts JSON as a string and converts it into the correct Puppet structure. * [`parseyaml`](#parseyaml): This function accepts YAML as a string and converts it into the correct Puppet structure. * [`pick`](#pick): This function is similar to a coalesce function in SQL in that it will return the first value in a list of values that is not undefined or an empty string. * [`pick_default`](#pick_default): This function will return the first value in a list of values that is not undefined or an empty string. * [`prefix`](#prefix): This function applies a prefix to all elements in an array or a hash. * [`private`](#private): **Deprecated:** Sets the current class or definition as private. Calling the class or definition from outside the current module will fail. * [`pry`](#pry): This function invokes a pry debugging session in the current scope object. * [`pw_hash`](#pw_hash): Hashes a password using the crypt function. Provides a hash usable on most POSIX systems. * [`range`](#range): When given range in the form of (start, stop) it will extrapolate a range as an array. * [`regexpescape`](#regexpescape): Regexp escape a string or array of strings. Requires either a single string or an array as an input. * [`reject`](#reject): This function searches through an array and rejects all elements that match the provided regular expression. * [`reverse`](#reverse): Reverses the order of a string or array. * [`round`](#round): Rounds a number to the nearest integer * [`rstrip`](#rstrip): Strips leading spaces to the right of the string. * [`seeded_rand`](#seeded_rand): Generates a random whole number greater than or equal to 0 and less than MAX, using the value of SEED for repeatable randomness. * [`seeded_rand_string`](#seeded_rand_string): Generates a consistent random string of specific length based on provided seed. * [`shell_escape`](#shell_escape): Escapes a string so that it can be safely used in a Bourne shell command line. * [`shell_join`](#shell_join): Builds a command line string from the given array of strings. Each array item is escaped for Bourne shell. All items are then joined together * [`shell_split`](#shell_split): Splits a string into an array of tokens in the same way the Bourne shell does. * [`shuffle`](#shuffle): @summary Randomizes the order of a string or array elements. * [`size`](#size): Returns the number of elements in a string, an array or a hash * [`sort`](#sort): Sorts strings and arrays lexically. * [`sprintf_hash`](#sprintf_hash): Uses sprintf with named references. * [`squeeze`](#squeeze): Returns a new string where runs of the same character that occur in this set are replaced by a single character. * [`stdlib::end_with`](#stdlibend_with): Returns true if str ends with one of the prefixes given. Each of the prefixes should be a String. * [`stdlib::extname`](#stdlibextname): Returns the Extension (the Portion of Filename in Path starting from the last Period). * [`stdlib::ip_in_range`](#stdlibip_in_range): Returns true if the ipaddress is within the given CIDRs * [`stdlib::start_with`](#stdlibstart_with): Returns true if str starts with one of the prefixes given. Each of the prefixes should be a String. * [`str2bool`](#str2bool): This converts a string to a boolean. * [`str2saltedpbkdf2`](#str2saltedpbkdf2): Convert a string into a salted SHA512 PBKDF2 password hash like requred for OS X / macOS 10.8+ * [`str2saltedsha512`](#str2saltedsha512): This converts a string to a salted-SHA512 password hash (which is used for OS X versions >= 10.7). * [`strip`](#strip): This function removes leading and trailing whitespace from a string or from every string inside an array. * [`suffix`](#suffix): This function applies a suffix to all elements in an array, or to the keys in a hash. * [`swapcase`](#swapcase): This function will swap the existing case of a string. * [`time`](#time): This function will return the current time since epoch as an integer. * [`to_bytes`](#to_bytes): Converts the argument into bytes, for example 4 kB becomes 4096. * [`to_json`](#to_json): Convert a data structure and output to JSON * [`to_json_pretty`](#to_json_pretty): Convert data structure and output to pretty JSON * [`to_yaml`](#to_yaml): Convert a data structure and output it as YAML * [`try_get_value`](#try_get_value): **DEPRECATED:** this function is deprecated, please use dig() instead. * [`type`](#type): **DEPRECATED:** This function will cease to function on Puppet 4; * [`type3x`](#type3x): **DEPRECATED:** This function will be removed when Puppet 3 support is dropped; please migrate to the new parser's typing system. * [`type_of`](#type_of): Returns the type of the passed value. * [`union`](#union): This function returns a union of two or more arrays. * [`unique`](#unique): This function will remove duplicates from strings and arrays. * [`unix2dos`](#unix2dos): Returns the DOS version of the given string. * [`upcase`](#upcase): Converts a string or an array of strings to uppercase. * [`uriescape`](#uriescape): Urlencodes a string or array of strings. Requires either a single string or an array as an input. * [`validate_absolute_path`](#validate_absolute_path): Validate the string represents an absolute path in the filesystem. This function works for windows and unix style paths. * [`validate_absolute_path`](#validate_absolute_path): Validate the string represents an absolute path in the filesystem. * [`validate_array`](#validate_array): Validate that all passed values are array data structures. Abort catalog compilation if any value fails this check. * [`validate_array`](#validate_array): Validate the passed value represents an array. * [`validate_augeas`](#validate_augeas): Perform validation of a string using an Augeas lens * [`validate_bool`](#validate_bool): Validate that all passed values are either true or false. Abort catalog compilation if any value fails this check. * [`validate_bool`](#validate_bool): Validate the passed value represents a boolean. * [`validate_cmd`](#validate_cmd): Perform validation of a string with an external command. * [`validate_domain_name`](#validate_domain_name): Validate that all values passed are syntactically correct domain names. Fail compilation if any value fails this check. * [`validate_email_address`](#validate_email_address): Validate that all values passed are valid email addresses. Fail compilation if any value fails this check. * [`validate_hash`](#validate_hash): Validate that all passed values are hash data structures. Abort catalog compilation if any value fails this check. * [`validate_hash`](#validate_hash): Validate the passed value represents a hash. * [`validate_integer`](#validate_integer): Validate that the first argument is an integer (or an array of integers). Abort catalog compilation if any of the checks fail. * [`validate_integer`](#validate_integer): Validate the passed value represents an integer. * [`validate_ip_address`](#validate_ip_address): Validate that all values passed are valid IP addresses, regardless they are IPv4 or IPv6 Fail compilation if any value fails this check. * [`validate_ip_address`](#validate_ip_address): Validate the passed value represents an ip_address. * [`validate_ipv4_address`](#validate_ipv4_address): Validate the passed value represents an ipv4_address. * [`validate_ipv4_address`](#validate_ipv4_address): Validate that all values passed are valid IPv4 addresses. Fail compilation if any value fails this check. * [`validate_ipv6_address`](#validate_ipv6_address): Validate that all values passed are valid IPv6 addresses. Fail compilation if any value fails this check. * [`validate_ipv6_address`](#validate_ipv6_address): Validate the passed value represents an ipv6_address. * [`validate_legacy`](#validate_legacy): Validate a value against both the target_type (new) and the previous_validation function (old). * [`validate_numeric`](#validate_numeric): Validate that the first argument is a numeric value (or an array of numeric values). Abort catalog compilation if any of the checks fail. * [`validate_numeric`](#validate_numeric): Validate the passed value represents a numeric value. * [`validate_re`](#validate_re): Perform simple validation of a string against one or more regular expressions. * [`validate_re`](#validate_re): Perform validation of a string against one or more regular expressions. * [`validate_slength`](#validate_slength): Validate that the first argument is a string (or an array of strings), and less/equal to than the length of the second argument. An optional third parameter can be given the minimum length. It fails if the first argument is not a string or array of strings, and if arg 2 and arg 3 are not convertable to a number. * [`validate_slength`](#validate_slength): Validate that a passed string has length less/equal with the passed value * [`validate_string`](#validate_string): Validate that all passed values are string data structures * [`validate_string`](#validate_string): Validate that all passed values are string data structures. * [`validate_x509_rsa_key_pair`](#validate_x509_rsa_key_pair): Validates a PEM-formatted X.509 certificate and RSA private key using OpenSSL. Verifies that the certficate's signature was created from the supplied key. * [`values`](#values): When given a hash this function will return the values of that hash. * [`values_at`](#values_at): Finds value inside an array based on location. * [`zip`](#zip): Takes one element from first array and merges corresponding elements from second array. ### Data types * [`Stdlib::Absolutepath`](#stdlibabsolutepath): A strict absolutepath type * [`Stdlib::Base32`](#stdlibbase32): Type to match base32 String * [`Stdlib::Base64`](#stdlibbase64): Type to match base64 String * [`Stdlib::Compat::Absolute_path`](#stdlibcompatabsolute_path): Emulate the is_absolute_path and validate_absolute_path functions The first pattern is originally from is_absolute_path, which had it from 2 * [`Stdlib::Compat::Array`](#stdlibcompatarray): Emulate the is_array and validate_array functions * [`Stdlib::Compat::Bool`](#stdlibcompatbool): Emulate the is_bool and validate_bool functions * [`Stdlib::Compat::Float`](#stdlibcompatfloat): Emulate the is_float function The regex is what's currently used in is_float To keep your development moving forward, you can also add a depr * [`Stdlib::Compat::Hash`](#stdlibcompathash): Emulate the is_hash and validate_hash functions * [`Stdlib::Compat::Integer`](#stdlibcompatinteger): Emulate the is_integer and validate_integer functions The regex is what's currently used in is_integer validate_numeric also allows range che * [`Stdlib::Compat::Ip_address`](#stdlibcompatip_address) * [`Stdlib::Compat::Ipv4`](#stdlibcompatipv4): Emulate the validate_ipv4_address and is_ipv4_address functions * [`Stdlib::Compat::Ipv6`](#stdlibcompatipv6) * [`Stdlib::Compat::Numeric`](#stdlibcompatnumeric): Emulate the is_numeric and validate_numeric functions The regex is what's currently used in is_numeric validate_numeric also allows range che * [`Stdlib::Compat::String`](#stdlibcompatstring): Emulate the is_string and validate_string functions * [`Stdlib::Datasize`](#stdlibdatasize) * [`Stdlib::Ensure::File`](#stdlibensurefile) * [`Stdlib::Ensure::File::Directory`](#stdlibensurefiledirectory) * [`Stdlib::Ensure::File::File`](#stdlibensurefilefile) * [`Stdlib::Ensure::File::Link`](#stdlibensurefilelink) * [`Stdlib::Ensure::Service`](#stdlibensureservice) * [`Stdlib::Filemode`](#stdlibfilemode): See `man chmod.1` for the regular expression for symbolic mode lint:ignore:140chars * [`Stdlib::Filesource`](#stdlibfilesource): Validate the source parameter on file types * [`Stdlib::Fqdn`](#stdlibfqdn) * [`Stdlib::HTTPSUrl`](#stdlibhttpsurl) * [`Stdlib::HTTPUrl`](#stdlibhttpurl) * [`Stdlib::Host`](#stdlibhost) * [`Stdlib::IP::Address`](#stdlibipaddress) * [`Stdlib::IP::Address::Nosubnet`](#stdlibipaddressnosubnet) * [`Stdlib::IP::Address::V4`](#stdlibipaddressv4) * [`Stdlib::IP::Address::V4::CIDR`](#stdlibipaddressv4cidr): lint:ignore:140chars * [`Stdlib::IP::Address::V4::Nosubnet`](#stdlibipaddressv4nosubnet): lint:ignore:140chars * [`Stdlib::IP::Address::V6`](#stdlibipaddressv6) * [`Stdlib::IP::Address::V6::Alternative`](#stdlibipaddressv6alternative): lint:ignore:140chars * [`Stdlib::IP::Address::V6::CIDR`](#stdlibipaddressv6cidr): lint:ignore:140chars * [`Stdlib::IP::Address::V6::Compressed`](#stdlibipaddressv6compressed) * [`Stdlib::IP::Address::V6::Full`](#stdlibipaddressv6full) * [`Stdlib::IP::Address::V6::Nosubnet`](#stdlibipaddressv6nosubnet) * [`Stdlib::IP::Address::V6::Nosubnet::Alternative`](#stdlibipaddressv6nosubnetalternative): lint:ignore:140chars * [`Stdlib::IP::Address::V6::Nosubnet::Compressed`](#stdlibipaddressv6nosubnetcompressed) * [`Stdlib::IP::Address::V6::Nosubnet::Full`](#stdlibipaddressv6nosubnetfull) * [`Stdlib::MAC`](#stdlibmac): A type for a MAC address * [`Stdlib::ObjectStore`](#stdlibobjectstore) * [`Stdlib::ObjectStore::GSUri`](#stdlibobjectstoregsuri) * [`Stdlib::ObjectStore::S3Uri`](#stdlibobjectstores3uri) * [`Stdlib::Port`](#stdlibport) * [`Stdlib::Port::Dynamic`](#stdlibportdynamic) * [`Stdlib::Port::Ephemeral`](#stdlibportephemeral) * [`Stdlib::Port::Privileged`](#stdlibportprivileged) * [`Stdlib::Port::Registered`](#stdlibportregistered) * [`Stdlib::Port::Unprivileged`](#stdlibportunprivileged) * [`Stdlib::Port::User`](#stdlibportuser) * [`Stdlib::Syslogfacility`](#stdlibsyslogfacility) * [`Stdlib::Unixpath`](#stdlibunixpath): this regex rejects any path component that does not start with "/" or is NUL * [`Stdlib::Windowspath`](#stdlibwindowspath) * [`Stdlib::Yes_no`](#stdlibyes_no) ## Classes ### `stdlib` Most of stdlib's features are automatically loaded by Puppet, but this class should be declared in order to use the standardized run stages. Declares all other classes in the stdlib module. Currently, this consists of stdlib::stages. ### `stdlib::stages` Declares various run-stages for deploying infrastructure, language runtimes, and application layers. The high level stages are (in order): * setup * main * runtime * setup_infra * deploy_infra * setup_app * deploy_app * deploy #### Examples ##### ```puppet node default { include ::stdlib class { java: stage => 'runtime' } } ``` ## Resource types ### `anchor` In Puppet 2.6, when a class declares another class, the resources in the interior class are not contained by the exterior class. This interacts badly with the pattern of composing complex modules from smaller classes, as it makes it impossible for end users to specify order relationships between the exterior class and other modules. The anchor type lets you work around this. By sandwiching any interior classes between two no-op resources that _are_ contained by the exterior class, you can ensure that all resources in the module are contained. ``` class ntp { # These classes will have the correct order relationship with each # other. However, without anchors, they won't have any order # relationship to Class['ntp']. class { 'ntp::package': } -> class { 'ntp::config': } -> class { 'ntp::service': } # These two resources "anchor" the composed classes within the ntp # class. anchor { 'ntp::begin': } -> Class['ntp::package'] Class['ntp::service'] -> anchor { 'ntp::end': } } ``` This allows the end user of the ntp module to establish require and before relationships with Class['ntp']: ``` class { 'ntp': } -> class { 'mcollective': } class { 'mcollective': } -> class { 'ntp': } ``` #### Parameters The following parameters are available in the `anchor` type. ##### `name` namevar The name of the anchor resource. ### `file_line` The implementation matches the full line, including whitespace at the beginning and end. If the line is not contained in the given file, Puppet will append the line to the end of the file to ensure the desired state. Multiple resources may be declared to manage multiple lines in the same file. * 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` 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 ### `abs` Type: Ruby 3.x API For example -34.56 becomes 34.56. Takes a single integer or float value as an argument. > *Note:* **Deprected** from Puppet 6.0.0, the built-in ['abs'](https://puppet.com/docs/puppet/6.4/function.html#abs)function will be used instead. #### `abs()` For example -34.56 becomes 34.56. Takes a single integer or float value as an argument. > *Note:* **Deprected** from Puppet 6.0.0, the built-in ['abs'](https://puppet.com/docs/puppet/6.4/function.html#abs)function will be used instead. Returns: `Any` The absolute value of the given number if it was an Integer ### `any2array` Type: Ruby 3.x API 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 va ##### Examples ###### Example usage ```puppet Encode and decode a string $encodestring = base64('encode', 'thestring') $decodestring = base64('decode', 'dGhlc3RyaW5n') Explicitly define encode/decode method: default, strict, urlsafe $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 ### `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 ### `camelcase` Type: Ruby 3.x API > *Note:* **Deprecated** from Puppet 6.0.0, this function has been replaced with a built-in [`camelcase`](https://puppet.com/docs/puppet/latest/function.html#camelcase) function. #### `camelcase()` > *Note:* **Deprecated** from Puppet 6.0.0, this function has been replaced with a built-in [`camelcase`](https://puppet.com/docs/puppet/latest/function.html#camelcase) function. Returns: `String` The converted String, if it was a String that was given ### `capitalize` Type: Ruby 3.x API Requires either a single string or an array as an input. > *Note:* **Deprecated** from Puppet 6.0.0, yhis function has been replaced with a built-in [`capitalize`](https://puppet.com/docs/puppet/latest/function.html#capitalize) function. #### `capitalize()` Requires either a single string or an array as an input. > *Note:* **Deprecated** from Puppet 6.0.0, yhis function has been replaced with a built-in [`capitalize`](https://puppet.com/docs/puppet/latest/function.html#capitalize) function. Returns: `String` The converted String, if it was a String that was given ### `ceiling` Type: Ruby 3.x API Takes a single numeric value as an argument. > *Note:* **Deprecated** from Puppet 6.0.0, this function has been replaced with a built-in [`ceiling`](https://puppet.com/docs/puppet/latest/function.html#ceiling) function. #### `ceiling()` Takes a single numeric value as an argument. > *Note:* **Deprecated** from Puppet 6.0.0, this function has been replaced with a built-in [`ceiling`](https://puppet.com/docs/puppet/latest/function.html#ceiling) function. Returns: `Integer` The rounded value ### `chomp` Type: Ruby 3.x API For example `hello\n` becomes `hello`. Requires a single string or array as an input. > *Note:* **Deprecated** from Puppet 6.0.0, this function has been replaced with a built-in [`chomp`](https://puppet.com/docs/puppet/latest/function.html#chomp) function. #### `chomp()` For example `hello\n` becomes `hello`. Requires a single string or array as an input. > *Note:* **Deprecated** from Puppet 6.0.0, this function has been replaced with a built-in [`chomp`](https://puppet.com/docs/puppet/latest/function.html#chomp) function. Returns: `String` The converted String, if it was a String that was given ### `chop` Type: Ruby 3.x API If the string ends with `\r\n`, both characters are removed. Applying chop to an empty string returns an empty string. If you wish to merely remove record separators then you should use the `chomp` function. Requires a string or array of strings as input. > *Note:* **Deprecated** from Puppet 6.0.0, this function has been replaced with a built-in [`chop`](https://puppet.com/docs/puppet/latest/function.html#chop) function. #### `chop()` If the string ends with `\r\n`, both characters are removed. Applying chop to an empty string returns an empty string. If you wish to merely remove record separators then you should use the `chomp` function. Requires a string or array of strings as input. > *Note:* **Deprecated** from Puppet 6.0.0, this function has been replaced with a built-in [`chop`](https://puppet.com/docs/puppet/latest/function.html#chop) function. Returns: `String` The given String, sans the last character. ### `clamp` Type: Ruby 3.x API Strings are converted and compared numerically. Arrays of values are flattened into a list for further handling. > *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 Str #### 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 Str 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 h ##### Examples ###### Example usage ```puppet $hash1 = {'one' => 1, 'two' => 2, 'three' => { 'four' => 4 } } $hash2 = {'two' => 'dos', 'three' => { 'five' => 5 } } $merged_hash = deep_merge($hash1, $hash2) The resulting hash is equivalent to: $merged_hash = { 'one' => 1, 'two' => 'dos', 'three' => { 'four' => 4, 'five' => 5 } } When there is a duplicate key that is a hash, they are recursively merged. When there is a duplicate key that is not a hash, the key in the rightmost hash will "win." ``` ### `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. The uniqueness key - can appear once. The msg is the message text including any positional information that is formatted by the user/caller of the method. It is affected by the puppet setting 'strict', which can be set to :error (outputs as an error message), :off (no message / error is displayed) and :warning (default, outputs a warning) *Type*: String, String. #### `deprecation(String $key, String $message)` Function to print deprecation warnings, Logs a warning once for a given key. The uniqueness key - can appear once. The msg is the message text including any positional information that is formatted by the user/caller of the method. It is affected by the puppet setting 'strict', which can be set to :error (outputs as an error message), :off (no message / error is displayed) and :warning (default, outputs a warning) *Type*: String, String. Returns: `Any` deprecated warnings ##### `key` Data type: `String` ##### `message` Data type: `String` ### `deprecation` Type: Ruby 3.x API The uniqueness key - can appear once. The msg is the message text including any positional information that is formatted by the user/caller of the method.). #### `deprecation()` The uniqueness key - can appear once. The msg is the message text including any positional information that is formatted by the user/caller of the method.). Returns: `String` return deprecation warnings ### `difference` Type: Ruby 3.x API 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"]` ``` ### `dig` Type: Ruby 3.x API In addition to the required path argument, the function accepts the default argument. It is returned if the path is not correct, if no value was found, or if any other error has occurred. ```ruby $data = { 'a' => { 'b' => [ 'b1', 'b2', 'b3', ] } } $value = dig($data, ['a', 'b', 2]) # $value = 'b3' # with all possible options $value = dig($data, ['a', 'b', 2], 'not_found') # $value = 'b3' # using the default value $value = dig($data, ['a', 'b', 'c', 'd'], 'not_found') # $value = 'not_found' ``` 1. `$data` The data structure we are working with. 2. `['a', 'b', 2]` The path array. 3. `not_found` The default value. It is returned if nothing is found. > **Note:* **Deprecated** This function has been replaced with a built-in [`dig`](https://puppet.com/docs/puppet/latest/function.html#dig) function as of Puppet 4.5.0. Use [`dig44()`](#dig44) for backwards compatibility or use the new version. #### `dig()` In addition to the required path argument, the function accepts the default argument. It is returned if the path is not correct, if no value was found, or if any other error has occurred. ```ruby $data = { 'a' => { 'b' => [ 'b1', 'b2', 'b3', ] } } $value = dig($data, ['a', 'b', 2]) # $value = 'b3' # with all possible options $value = dig($data, ['a', 'b', 2], 'not_found') # $value = 'b3' # using the default value $value = dig($data, ['a', 'b', 'c', 'd'], 'not_found') # $value = 'not_found' ``` 1. `$data` The data structure we are working with. 2. `['a', 'b', 2]` The path array. 3. `not_found` The default value. It is returned if nothing is found. > **Note:* **Deprecated** This function has been replaced with a built-in [`dig`](https://puppet.com/docs/puppet/latest/function.html#dig) function as of Puppet 4.5.0. Use [`dig44()`](#dig44) for backwards compatibility or use the new version. Returns: `Any` The function goes through the structure by each path component and tries to return the value at the end of the path. ### `dig44` Type: Ruby 3.x API Key can contain slashes to describe path components. The function will go down the structure and try to extract the required value. ``` $data = { 'a' => { 'b' => [ 'b1', 'b2', 'b3', ] } } $value = dig44($data, ['a', 'b', 2]) # $value = 'b3' # with all possible options $value = dig44($data, ['a', 'b', 2], 'not_found') # $value = 'b3' # using the default value $value = dig44($data, ['a', 'b', 'c', 'd'], 'not_found') # $value = 'not_found' ``` > **Note:* **Deprecated** This function has been replaced with a built-in [`dig`](https://puppet.com/docs/puppet/latest/function.html#dig) function as of Puppet 4.5.0. #### `dig44()` Key can contain slashes to describe path components. The function will go down the structure and try to extract the required value. ``` $data = { 'a' => { 'b' => [ 'b1', 'b2', 'b3', ] } } $value = dig44($data, ['a', 'b', 2]) # $value = 'b3' # with all possible options $value = dig44($data, ['a', 'b', 2], 'not_found') # $value = 'b3' # using the default value $value = dig44($data, ['a', 'b', 'c', 'd'], 'not_found') # $value = 'not_found' ``` > **Note:* **Deprecated** This function has been replaced with a built-in [`dig`](https://puppet.com/docs/puppet/latest/function.html#dig) function as of Puppet 4.5.0. Returns: `String` 'not_found' will be returned if nothing is found ### `dirname` Type: Ruby 3.x API Returns the dirname of a path. #### `dirname()` The dirname function. Returns: `String` the given path's dirname ### `dos2unix` Type: Ruby 3.x API Takes a single string argument. #### `dos2unix()` Takes a single string argument. Returns: `Any` The retrieved version ### `downcase` Type: Ruby 3.x API > *Note:* **Deprecated** from Puppet 6.0.0, this function has been replaced with a built-in [`downcase`](https://puppet.com/docs/puppet/latest/function.html#downcase) function. > This function is an implementation of a Ruby class and might not be UTF8 compatible. To ensure compatibility, use this function with Ruby 2.4.0 or greater. #### `downcase()` > *Note:* **Deprecated** from Puppet 6.0.0, this function has been replaced with a built-in [`downcase`](https://puppet.com/docs/puppet/latest/function.html#downcase) function. > This function is an implementation of a Ruby class and might not be UTF8 compatible. To ensure compatibility, use this function with Ruby 2.4.0 or greater. Returns: `String` The converted String, if it was a String that was given ### `empty` Type: Ruby 3.x API > *Note*: **Deprecated** from Puppet 5.5.0, the built-in [`empty`](https://puppet.com/docs/puppet/6.4/function.html#empty) function will be used instead. #### `empty()` > *Note*: **Deprecated** from Puppet 5.5.0, the built-in [`empty`](https://puppet.com/docs/puppet/6.4/function.html#empty) function will be used instead. Returns: `Any` Returns `true` if the argument is an array or hash that contains no elements, or an empty string. Returns `false` when the argument is a numerical value. ### `enclose_ipv6` Type: Ruby 3.x API 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 3.x API It optionally takes a hash as a second parameter that will be passed as the third argument to the ensure_resource() function. #### `ensure_packages()` It optionally takes a hash as a second parameter that will be passed as the third argument to the ensure_resource() function. Returns: `Any` install the passed packages ### `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 ### `flatten` Type: Ruby 3.x API > **Note:** **Deprecated** from Puppet 5.5.0, this function has been replaced with a built-in [`flatten`](https://puppet.com/docs/puppet/latest/function.html#flatten) function. #### Examples ##### Example usage ```puppet flatten(['a', ['b', ['c']]])` returns: `['a','b','c'] ``` #### `flatten()` > **Note:** **Deprecated** from Puppet 5.5.0, this function has been replaced with a built-in [`flatten`](https://puppet.com/docs/puppet/latest/function.html#flatten) function. Returns: `Any` convert nested arrays into a single flat array ##### Examples ###### Example usage ```puppet flatten(['a', ['b', ['c']]])` returns: `['a','b','c'] ``` ### `floor` Type: Ruby 3.x API Takes a single numeric value as an argument. > **Note:** **Deprecated** from Puppet 6.0.0, this function has been replaced with a built-in [`floor`](https://puppet.com/docs/puppet/latest/function.html#floor) function. #### `floor()` Takes a single numeric value as an argument. > **Note:** **Deprecated** from Puppet 6.0.0, this function has been replaced with a built-in [`floor`](https://puppet.com/docs/puppet/latest/function.html#floor) function. Returns: `Any` the largest integer less or equal to the argument. ### `fqdn_rand_string` Type: Ruby 3.x API Optionally, you can specify a character set for the function (defaults to alphanumeric). Arguments * An integer, specifying the length of the resulting string. * Optionally, a string specifying the character set. * Optionally, a string specifying the seed for repeatable randomness. #### Examples ##### Example Usage: ```puppet fqdn_rand_string(10) fqdn_rand_string(10, 'ABCDEF!@$%^') fqdn_rand_string(10, '', 'custom seed') ``` #### `fqdn_rand_string()` Optionally, you can specify a character set for the function (defaults to alphanumeric). Arguments * An integer, specifying the length of the resulting string. * Optionally, a string specifying the character set. * Optionally, a string specifying the seed for repeatable randomness. Returns: `String` ##### Examples ###### Example Usage: ```puppet fqdn_rand_string(10) fqdn_rand_string(10, 'ABCDEF!@$%^') fqdn_rand_string(10, '', 'custom seed') ``` ### `fqdn_rotate` Type: Ruby 3.x API Rotates an array or string a random number of times, combining the `$fqdn` fact and an optional seed for repeatable randomness. #### Examples ##### Example Usage: ```puppet fqdn_rotate(['a', 'b', 'c', 'd']) fqdn_rotate('abcd') fqdn_rotate([1, 2, 3], 'custom seed') ``` #### `fqdn_rotate()` The fqdn_rotate function. Returns: `Any` rotated array or string ##### Examples ###### Example Usage: ```puppet fqdn_rotate(['a', 'b', 'c', 'd']) fqdn_rotate('abcd') fqdn_rotate([1, 2, 3], 'custom seed') ``` ### `fqdn_uuid` Type: Ruby 3.x API Returns a [RFC 4122](https://tools.ietf.org/html/rfc4122) valid version 5 UUID based on an FQDN string under the DNS namespace #### Examples ##### Example Usage: ```puppet fqdn_uuid('puppetlabs.com') # Returns '9c70320f-6815-5fc5-ab0f-debe68bf764c' fqdn_uuid('google.com') # Returns '64ee70a4-8cc1-5d25-abf2-dea6c79a09 ``` #### `fqdn_uuid()` The fqdn_uuid function. Returns: `Any` 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-dea6c79a09 ``` ### `get_module_path` Type: Ruby 3.x API > *Note:* that since Puppet 5.4.0 the built-in [`module_directory`](https://puppet.com/docs/puppet/latest/function.html#module_directory) function in Puppet does the same thing and will return the path to the first found module if given multiple values or an array. #### Examples ##### Example Usage: ```puppet $module_path = get_module_path('stdlib') ``` #### `get_module_path()` > *Note:* that since Puppet 5.4.0 the built-in [`module_directory`](https://puppet.com/docs/puppet/latest/function.html#module_directory) function in Puppet does the same thing and will return the path to the first found module if given multiple values or an array. Returns: `Any` 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': } ``` ### `getvar` Type: Ruby 3.x API > **Note:** from Puppet 6.0.0, the compatible function with the same name in Puppet core will be used instead of this function. The new function also has support for digging into a structured value. See the built-in [`getvar`](https://puppet.com/docs/puppet/latest/function.html#getvar) funct #### Examples ##### Example usage ```puppet $foo = getvar('site::data::foo') # Equivalent to $foo = $site::data::foo ``` ##### Where namespace is stored in a string ```puppet $datalocation = 'site::data' $bar = getvar("${datalocation}::bar") # Equivalent to $bar = $site::data::bar ``` #### `getvar()` > **Note:** from Puppet 6.0.0, the compatible function with the same name in Puppet core will be used instead of this function. The new function also has support for digging into a structured value. See the built-in [`getvar`](https://puppet.com/docs/puppet/latest/function.html#getvar) funct Returns: `Any` undef - if variable does not exist ##### Examples ###### Example usage ```puppet $foo = getvar('site::data::foo') # Equivalent to $foo = $site::data::foo ``` ###### Where namespace is stored in a string ```puppet $datalocation = 'site::data' $bar = getvar("${datalocation}::bar") # Equivalent to $bar = $site::data::bar ``` ### `glob` Type: Ruby 3.x API Uses same patterns as Dir#glob. #### Examples ##### Example Usage: ```puppet $confs = glob(['/etc/**/*.conf', '/opt/**/*.conf']) ``` #### `glob()` 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 3.x API Valid kinds are `macaddress`, `netmask`, `ipaddress` and `network`. #### Examples ##### **Usage** ```puppet has_interface_with("macaddress", "x:x:x:x:x:x") # Returns `false` has_interface_with("ipaddress", "127.0.0.1") # Returns `true` ``` ##### If no "kind" is given, then the presence of the interface is checked: ```puppet has_interface_with("lo") # Returns `true` ``` #### `has_interface_with()` Valid kinds are `macaddress`, `netmask`, `ipaddress` and `network`. Returns: `Any` boolean values `true` or `false` ##### Examples ###### **Usage** ```puppet has_interface_with("macaddress", "x:x:x:x:x:x") # Returns `false` has_interface_with("ipaddress", "127.0.0.1") # Returns `true` ``` ###### If no "kind" is given, then the presence of the interface is checked: ```puppet has_interface_with("lo") # Returns `true` ``` ### `has_ip_address` Type: Ruby 3.x API This function iterates through the 'interfaces' fact and checks the 'ipaddress_IFACE' facts, performing a simple string comparison. #### `has_ip_address()` This function iterates through the 'interfaces' fact and checks the 'ipaddress_IFACE' facts, performing a simple string comparison. Returns: `Boolean` `true` or `false` ### `has_ip_network` Type: Ruby 3.x API This function iterates through the 'interfaces' fact and checks the 'network_IFACE' facts, performing a simple string comparision. #### `has_ip_network()` This function iterates through the 'interfaces' fact and checks the 'network_IFACE' facts, performing a simple string comparision. Returns: `Any` Boolean value, `true` if the client has an IP address within the requested network. ### `has_key` Type: Ruby 3.x API > **Note:** **Deprecated** since Puppet 4.0.0, this can now be achieved in the Puppet language with the following equivalent expression: $my_hash = {'key_one' => 'value_one'} if 'key_one' in $my_hash { notice('this will be printed') #### Examples ##### Example Usage: ```puppet $my_hash = {'key_one' => 'value_one'} if has_key($my_hash, 'key_two') { notice('we will not reach here') } if has_key($my_hash, 'key_one') { notice('this will be printed') } ``` #### `has_key()` > **Note:** **Deprecated** since Puppet 4.0.0, this can now be achieved in the Puppet language with the following equivalent expression: $my_hash = {'key_one' => 'value_one'} if 'key_one' in $my_hash { notice('this will be printed') Returns: `Any` Boolean value ##### Examples ###### Example Usage: ```puppet $my_hash = {'key_one' => 'value_one'} if has_key($my_hash, 'key_two') { notice('we will not reach here') } if has_key($my_hash, 'key_one') { notice('this will be printed') } ``` ### `hash` Type: Ruby 3.x API > **Note:** This function has been replaced with the built-in ability to create a new value of almost any data type - see the built-in [`Hash.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-hash-and-struct) function in Puppet. This example shows the equivalent expression in the Puppet language: ``` Hash(['a',1,'b',2,'c',3]) Hash([['a',1],['b',2],['c',3]]) ``` #### Examples ##### Example Usage: ```puppet hash(['a',1,'b',2,'c',3]) # Returns: {'a'=>1,'b'=>2,'c'=>3} ``` #### `hash()` > **Note:** This function has been replaced with the built-in ability to create a new value of almost any data type - see the built-in [`Hash.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-hash-and-struct) function in Puppet. This example shows the equivalent expression in the Puppet language: ``` Hash(['a',1,'b',2,'c',3]) Hash([['a',1],['b',2],['c',3]]) ``` Returns: `Any` the converted array as a hash ##### Examples ###### Example Usage: ```puppet hash(['a',1,'b',2,'c',3]) # Returns: {'a'=>1,'b'=>2,'c'=>3} ``` ### `intersection` Type: Ruby 3.x API 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 ### `is_absolute_path` Type: Ruby 4.x API Wrapper that calls the Puppet 3.x function of the same name. #### `is_absolute_path(Any $scope, Any *$args)` The is_absolute_path function. Returns: `Boolea` A boolean value returned from the called 3.x function. ##### `scope` Data type: `Any` The main value that will be passed to the wrapped method ##### `*args` Data type: `Any` Any additional values that are to be passed to the wrapped method ### `is_absolute_path` Type: Ruby 3.x API This function works for windows and unix style paths. > **Note:* **Deprecated** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_leg #### Examples ##### The following values will return true: ```puppet $my_path = 'C:/Program Files (x86)/Puppet Labs/Puppet' is_absolute_path($my_path) $my_path2 = '/var/lib/puppet' is_absolute_path($my_path2) $my_path3 = ['C:/Program Files (x86)/Puppet Labs/Puppet'] is_absolute_path($my_path3) $my_path4 = ['/var/lib/puppet'] is_absolute_path($my_path4) ``` ##### The following values will return false: ```puppet is_absolute_path(true) is_absolute_path('../var/lib/puppet') is_absolute_path('var/lib/puppet') $undefined = undef is_absolute_path($undefined) ``` #### `is_absolute_path()` This function works for windows and unix style paths. > **Note:* **Deprecated** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_leg Returns: `Boolean` Returns `true` or `false` ##### Examples ###### The following values will return true: ```puppet $my_path = 'C:/Program Files (x86)/Puppet Labs/Puppet' is_absolute_path($my_path) $my_path2 = '/var/lib/puppet' is_absolute_path($my_path2) $my_path3 = ['C:/Program Files (x86)/Puppet Labs/Puppet'] is_absolute_path($my_path3) $my_path4 = ['/var/lib/puppet'] is_absolute_path($my_path4) ``` ###### The following values will return false: ```puppet is_absolute_path(true) is_absolute_path('../var/lib/puppet') is_absolute_path('var/lib/puppet') $undefined = undef is_absolute_path($undefined) ``` ### `is_array` Type: Ruby 4.x API Wrapper that calls the Puppet 3.x function of the same name. #### `is_array(Any $scope, Any *$args)` The is_array function. Returns: `Boolea` A boolean value returned from the called 3.x function. ##### `scope` Data type: `Any` The main value that will be passed to the wrapped method ##### `*args` Data type: `Any` Any additional values that are to be passed to the wrapped method ### `is_array` Type: Ruby 3.x API > **Note:* **Deprecated** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). #### `is_array()` > **Note:* **Deprecated** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). Returns: `Boolean` Returns `true` or `false` ### `is_bool` Type: Ruby 4.x API Wrapper that calls the Puppet 3.x function of the same name. #### `is_bool(Any $scope, Any *$args)` The is_bool function. Returns: `Boolea` A boolean value returned from the called 3.x function. ##### `scope` Data type: `Any` The main value that will be passed to the wrapped method ##### `*args` Data type: `Any` Any additional values that are to be passed to the wrapped method ### `is_bool` Type: Ruby 3.x API > **Note:* **Deprecated** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). #### `is_bool()` > **Note:* **Deprecated** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). Returns: `Boolean` Returns `true` or `false` ### `is_domain_name` Type: Ruby 3.x API > **Note:* **Deprecated** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). #### `is_domain_name()` > **Note:* **Deprecated** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). Returns: `Boolean` Returns `true` or `false` ### `is_email_address` Type: Ruby 3.x API > **Note:* **Deprecated** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). #### `is_email_address()` > **Note:* **Deprecated** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). Returns: `Boolean` Returns `true` or `false` ### `is_float` Type: Ruby 3.x API > **Note:* **Deprecated** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). #### `is_float()` > **Note:* **Deprecated** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). Returns: `Boolean` Returns `true` or `false` ### `is_float` Type: Ruby 4.x API Wrapper that calls the Puppet 3.x function of the same name. #### `is_float(Any $scope, Any *$args)` The is_float function. Returns: `Boolea` A boolean value returned from the called 3.x function. ##### `scope` Data type: `Any` The main value that will be passed to the wrapped method ##### `*args` Data type: `Any` Any additional values that are to be passed to the wrapped method ### `is_function_available` Type: Ruby 3.x API This function accepts a string as an argument. > **Note:* **Deprecated** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). #### `is_function_available()` This function accepts a string as an argument. > **Note:* **Deprecated** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). Returns: `Boolean` Returns `true` or `false` ### `is_hash` Type: Ruby 3.x API > **Note:* **Deprecated** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). #### `is_hash()` > **Note:* **Deprecated** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). Returns: `Boolean` Returns `true` or `false` ### `is_integer` Type: Ruby 3.x API The string may start with a '-' (minus). A value of '0' is allowed, but a leading '0' digit may not be followed by other digits as this indicates that the value is octal (base 8). If given any other argument `false` is returned. > **Note:* **Deprecated** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). #### `is_integer()` The string may start with a '-' (minus). A value of '0' is allowed, but a leading '0' digit may not be followed by other digits as this indicates that the value is octal (base 8). If given any other argument `false` is returned. > **Note:* **Deprecated** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). Returns: `Boolean` Returns `true` or `false` ### `is_ip_address` Type: Ruby 4.x API Wrapper that calls the Puppet 3.x function of the same name. #### `is_ip_address(Any $scope, Any *$args)` The is_ip_address function. Returns: `Boolea` A boolean value returned from the called 3.x function. ##### `scope` Data type: `Any` The main value that will be passed to the wrapped method ##### `*args` Data type: `Any` Any additional values that are to be passed to the wrapped method ### `is_ip_address` Type: Ruby 3.x API > **Note:* **Deprecated** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). #### `is_ip_address()` > **Note:* **Deprecated** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). Returns: `Boolean` Returns `true` or `false` ### `is_ipv4_address` Type: Ruby 4.x API Wrapper that calls the Puppet 3.x function of the same name. #### `is_ipv4_address(Any $scope, Any *$args)` The is_ipv4_address function. Returns: `Boolea` A boolean value returned from the called 3.x function. ##### `scope` Data type: `Any` The main value that will be passed to the wrapped method ##### `*args` Data type: `Any` Any additional values that are to be passed to the wrapped method ### `is_ipv4_address` Type: Ruby 3.x API > **Note:* **Deprecated** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). #### `is_ipv4_address()` > **Note:* **Deprecated** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). Returns: `Boolean` Returns `true` or `false` ### `is_ipv6_address` Type: Ruby 4.x API Wrapper that calls the Puppet 3.x function of the same name. #### `is_ipv6_address(Any $scope, Any *$args)` The is_ipv6_address function. Returns: `Boolea` A boolean value returned from the called 3.x function. ##### `scope` Data type: `Any` The main value that will be passed to the wrapped method ##### `*args` Data type: `Any` Any additional values that are to be passed to the wrapped method ### `is_ipv6_address` Type: Ruby 3.x API > **Note:* **Deprecated** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). #### `is_ipv6_address()` > **Note:* **Deprecated** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). Returns: `Boolean` Returns `true` or `false` ### `is_mac_address` Type: Ruby 3.x API > **Note:* **Deprecated** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). #### `is_mac_address()` > **Note:* **Deprecated** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). Returns: `Boolean` Returns `true` or `false` ### `is_numeric` Type: Ruby 3.x API Returns true if the given argument is a Numeric (Integer or Float), or a String containing either a valid integer in decimal base 10 form, or a valid floating point string representation. The function recognizes only decimal (base 10) integers and float but not integers in hex (base 16) or octal (base 8) form. The string representation may start with a '-' (minus). If a decimal '.' is used, it must be followed by at least one digit. > **Note:* **Deprecated** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). #### `is_numeric()` Returns true if the given argument is a Numeric (Integer or Float), or a String containing either a valid integer in decimal base 10 form, or a valid floating point string representation. The function recognizes only decimal (base 10) integers and float but not integers in hex (base 16) or octal (base 8) form. The string representation may start with a '-' (minus). If a decimal '.' is used, it must be followed by at least one digit. > **Note:* **Deprecated** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). Returns: `Boolean` Returns `true` or `false` ### `is_numeric` Type: Ruby 4.x API Wrapper that calls the Puppet 3.x function of the same name. #### `is_numeric(Any $scope, Any *$args)` The is_numeric function. Returns: `Boolea` A boolean value returned from the called 3.x function. ##### `scope` Data type: `Any` The main value that will be passed to the wrapped method ##### `*args` Data type: `Any` Any additional values that are to be passed to the wrapped method ### `is_string` Type: Ruby 4.x API Wrapper that calls the Puppet 3.x function of the same name. #### `is_string(Any $scope, Any *$args)` The is_string function. Returns: `Boolean` A boolean value returned from the called 3.x function. ##### `scope` Data type: `Any` The main value that will be passed to the wrapped method ##### `*args` Data type: `Any` Any additional values that are to be passed to the wrapped method ### `is_string` Type: Ruby 3.x API > **Note:* **Deprecated** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). #### `is_string()` > **Note:* **Deprecated** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). Returns: `Boolean` Returns `true` or `false` ### `join` Type: Ruby 3.x API > **Note:** **Deprecated** from Puppet 5.4.0 this function has been replaced with a built-in [`join`](https://puppet.com/docs/puppet/latest/function.html#join) function. #### Examples ##### Example Usage: ```puppet join(['a','b','c'], ",") # Results in: "a,b,c" ``` #### `join()` > **Note:** **Deprecated** from Puppet 5.4.0 this function has been replaced with a built-in [`join`](https://puppet.com/docs/puppet/latest/function.html#join) function. Returns: `String` The String containing each of the array values ##### Examples ###### Example Usage: ```puppet join(['a','b','c'], ",") # Results in: "a,b,c" ``` ### `join_keys_to_values` Type: Ruby 3.x API Keys are cast to strings. If values are arrays, multiple keys are added for each element. The return value is an array in which each element is one joined key/value pair. > **Note:** Since Puppet 5.0.0 - for more detailed control over the formatting (including indentations and line breaks, delimiters around arrays and hash entries, between key/values in hash entries, and individual formatting of values in the array) - see the `new` function for `String` and its formatting options for `Array` and `Hash`. #### Examples ##### Example Usage: ```puppet join_keys_to_values({'a'=>1,'b'=>2}, " is ") # Results in: ["a is 1","b is 2"] join_keys_to_values({'a'=>1,'b'=>[2,3]}, " is ") # Results in: ["a is 1","b is 2","b is 3"] ``` #### `join_keys_to_values()` Keys are cast to strings. If values are arrays, multiple keys are added for each element. The return value is an array in which each element is one joined key/value pair. > **Note:** Since Puppet 5.0.0 - for more detailed control over the formatting (including indentations and line breaks, delimiters around arrays and hash entries, between key/values in hash entries, and individual formatting of values in the array) - see the `new` function for `String` and its formatting options for `Array` and `Hash`. Returns: `Hash` The joined hash ##### Examples ###### Example Usage: ```puppet join_keys_to_values({'a'=>1,'b'=>2}, " is ") # Results in: ["a is 1","b is 2"] join_keys_to_values({'a'=>1,'b'=>[2,3]}, " is ") # Results in: ["a is 1","b is 2","b is 3"] ``` ### `keys` Type: Ruby 3.x API > **Note:** **Deprecated** from Puppet 5.5.0, the built-in [`keys`](https://puppet.com/docs/puppet/latest/function.html#keys) function will be used instead of this function. #### `keys()` > **Note:** **Deprecated** from Puppet 5.5.0, the built-in [`keys`](https://puppet.com/docs/puppet/latest/function.html#keys) function will be used instead of this function. Returns: `Array` An array containing each of the hashes key values. ### `length` Type: Ruby 4.x API The original size() function did not handle Puppets new type capabilities, so this function is a Puppet 4 compatible solution. > **Note:** **Deprecated** from Puppet 6.0.0, this function has been replaced with a built-in [`length`](https://puppet.com/docs/puppet/latest/function.html#length) function. #### `length(Variant[String,Array,Hash] $value)` The original size() function did not handle Puppets new type capabilities, so this function is a Puppet 4 compatible solution. > **Note:** **Deprecated** from Puppet 6.0.0, this function has been replaced with a built-in [`length`](https://puppet.com/docs/puppet/latest/function.html#length) function. Returns: `Integer` The length of the given object ##### `value` Data type: `Variant[String,Array,Hash]` The value whose length is to be found ### `load_module_metadata` Type: Ruby 3.x API This function loads the metadata of a given module. #### Examples ##### Example USage: ```puppet $metadata = load_module_metadata('archive') notify { $metadata['author']: } ``` #### `load_module_metadata()` The load_module_metadata function. Returns: `Any` The modules metadata ##### Examples ###### Example USage: ```puppet $metadata = load_module_metadata('archive') notify { $metadata['author']: } ``` ### `loadjson` Type: Ruby 3.x API The first parameter can be a file path or a URL. The second parameter is the default value. It will be returned if the file was not found or could not be parsed. #### Examples ##### Example Usage: ```puppet $myhash = loadjson('/etc/puppet/data/myhash.json') $myhash = loadjson('https://example.local/my_hash.json') $myhash = loadjson('https://username:password@example.local/my_hash.json') $myhash = loadjson('no-file.json', {'default' => 'val ``` #### `loadjson()` The first parameter can be a file path or a URL. The second parameter is the default value. It will be returned if the file was not found or could not be parsed. Returns: `Array|String|Hash` The data stored in the JSON file, the type depending on the type of data that was stored. ##### Examples ###### Example Usage: ```puppet $myhash = loadjson('/etc/puppet/data/myhash.json') $myhash = loadjson('https://example.local/my_hash.json') $myhash = loadjson('https://username:password@example.local/my_hash.json') $myhash = loadjson('no-file.json', {'default' => 'val ``` ### `loadyaml` Type: Ruby 3.x API The first parameter can be a file path or a URL. The second parameter is the default value. It will be returned if the file was not found or could not be parsed. #### Examples ##### Example Usage: ```puppet $myhash = loadyaml('/etc/puppet/data/myhash.yaml') $myhash = loadyaml('https://example.local/my_hash.yaml') $myhash = loadyaml('https://username:password@example.local/my_hash.yaml') $myhash = loadyaml('no-file.yaml', {'default' => 'val ``` #### `loadyaml()` The first parameter can be a file path or a URL. The second parameter is the default value. It will be returned if the file was not found or could not be parsed. Returns: `Array|String|Hash` The data stored in the YAML file, the type depending on the type of data that was stored. ##### Examples ###### Example Usage: ```puppet $myhash = loadyaml('/etc/puppet/data/myhash.yaml') $myhash = loadyaml('https://example.local/my_hash.yaml') $myhash = loadyaml('https://username:password@example.local/my_hash.yaml') $myhash = loadyaml('no-file.yaml', {'default' => 'val ``` ### `lstrip` Type: Ruby 3.x API > **Note:** **Deprecated** from Puppet 6.0.0, this function has been replaced with a built-in [`max`](https://puppet.com/docs/puppet/latest/function.html#max) function. #### `lstrip()` > **Note:** **Deprecated** from Puppet 6.0.0, this function has been replaced with a built-in [`max`](https://puppet.com/docs/puppet/latest/function.html#max) function. Returns: `String` The stripped string ### `max` Type: Ruby 3.x API Requires at least one argument. > **Note:** **Deprecated** from Puppet 6.0.0, this function has been replaced with a built-in [`lstrip`](https://puppet.com/docs/puppet/latest/function.html#lstrip) function. #### `max()` Requires at least one argument. > **Note:** **Deprecated** from Puppet 6.0.0, this function has been replaced with a built-in [`lstrip`](https://puppet.com/docs/puppet/latest/function.html#lstrip) function. Returns: `Any` The highest value among those passed in ### `member` Type: Ruby 3.x API The variable can be a string, fixnum, or array. > **Note**: This function does not support nested arrays. If the first argument contains nested arrays, it will not recurse through them. > *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 3.x API When there is a duplicate key, the key in the rightmost hash will "win." Note that since Puppet 4.0.0 the same merge can be achieved with the + operator. `$merged_hash = $hash1 + $has #### Examples ##### **Usage** ```puppet $hash1 = {'one' => 1, 'two', => 2} $hash2 = {'two' => 'dos', 'three', => 'tres'} $merged_hash = merge($hash1, $hash2) # $merged_hash = {'one' => 1, 'two' => 'dos', 'three' => 'tres'} ``` #### `merge()` When there is a duplicate key, the key in the rightmost hash will "win." Note that since Puppet 4.0.0 the same merge can be achieved with the + operator. `$merged_hash = $hash1 + $has Returns: `Hash` The merged hash ##### Examples ###### **Usage** ```puppet $hash1 = {'one' => 1, 'two', => 2} $hash2 = {'two' => 'dos', 'three', => 'tres'} $merged_hash = merge($hash1, $hash2) # $merged_hash = {'one' => 1, 'two' => 'dos', 'three' => 'tres'} ``` ### `merge` Type: Ruby 4.x API When there is a duplicate key, the key in the rightmost hash will "win." Note that since Puppet 4.0.0 the same merge can be achieved with the + operator. `$merged_hash = $hash1 + $hash2` If merge is given a single Iterable (Array, Hash, etc.) it will call a given block with up to three parameters, and merge each resulting Hash into the accumulated result. All other types of values returned from the block (typically undef) are skipped (not merged). The codeblock can take 2 or three parameters: * with two, it gets the current hash (as built to this point), and each value (for hash the value is a [key, value] tuple) * with three, it gets the current hash (as built to this point), the key/index of each value, and then the value If the iterable is empty, or no hash was returned from the given block, an empty hash is returned. In the given block, a call to `next()` will skip that entry, and a call to `break()` will end the iteration. The iterative `merge()` has an advantage over doing the same with a general `reduce()` in that the constructed hash does not have to be copied in each iteration and thus will perform much better with large inputs. #### Examples ##### Using merge() ```puppet $hash1 = {'one' => 1, 'two', => 2} $hash2 = {'two' => 'dos', 'three', => 'tres'} $merged_hash = merge($hash1, $hash2) # $merged_hash = {'one' => 1, 'two' => 'dos', 'three' => 'tres'} ``` ##### counting occurrences of strings in an array ```puppet ['a', 'b', 'c', 'c', 'd', 'b'].merge | $hsh, $v | { { $v => $hsh[$v].lest || { 0 } + 1 } } # results in { a => 1, b => 2, c => 2, d => 1 } ``` ##### skipping values for entries that are longer than 1 char ```puppet ['a', 'b', 'c', 'c', 'd', 'b', 'blah', 'blah'].merge | $hsh, $v | { if $v =~ String[1,1] { { $v => $hsh[$v].lest || { 0 } + 1 } } } # results in { a => 1, b => 2, c => 2, d => 1 } ``` #### `merge(Variant[Hash, Undef, String[0,0]] *$args)` The merge function. Returns: `Hash` The merged hash ##### `*args` Data type: `Variant[Hash, Undef, String[0,0]]` Repeated Param - The hashes that are to be merged #### `merge(Iterable *$args, Callable[3,3] &$block)` The merge function. Returns: `Hash` The merged hash ##### `*args` Data type: `Iterable` Repeated Param - The hashes that are to be merged ##### `&block` Data type: `Callable[3,3]` A block placed on the repeatable param `args` #### `merge(Iterable *$args, Callable[2,2] &$block)` The merge function. Returns: `Hash` The merged hash ##### `*args` Data type: `Iterable` Repeated Param - The hashes that are to be merged ##### `&block` Data type: `Callable[2,2]` A block placed on the repeatable param `args` ### `min` Type: Ruby 3.x API Requires at least one argument. > **Note:** **Deprecated** from Puppet 6.0.0, this function has been replaced with a built-in [`min`](https://puppet.com/docs/puppet/latest/function.html#min) function. #### `min()` Requires at least one argument. > **Note:** **Deprecated** from Puppet 6.0.0, this function has been replaced with a built-in [`min`](https://puppet.com/docs/puppet/latest/function.html#min) function. Returns: `Any` The lowest value among the given arguments ### `num2bool` Type: Ruby 3.x API > *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 > *Note:* Only the major version is taken into account. #### Examples ##### Example usage:# ```puppet if os_version_gte('Debian', '9') { } if os_version_gte('Ubuntu', '18.04') { } ``` #### `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 os_version_gte('Debian', '9') { } if os_version_gte('Ubuntu', '18.04') { } ``` ##### `os` Data type: `String[1]` operating system ##### `version` Data type: `String[1]` ### `parsehocon` Type: Ruby 4.x API This function accepts HOCON as a string and converts it into the correct Puppet structure #### Examples ##### How to parse hocon ```puppet $data = parsehocon("{any valid hocon: string}") ``` #### `parsehocon(String $hocon_string, Optional[Any] $default)` The parsehocon function. Returns: `Any` ##### Examples ###### How to parse hocon ```puppet $data = parsehocon("{any valid hocon: string}") ``` ##### `hocon_string` Data type: `String` A valid HOCON string ##### `default` Data type: `Optional[Any]` An optional default to return if parsing hocon_string fails ### `parsejson` Type: Ruby 3.x API > *Note:* The optional second argument can be used to pass a default value that will be returned if the parsing of YAML string have failed. #### `parsejson()` > *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` convert JSON into Puppet structure ### `parseyaml` Type: Ruby 3.x API > *Note:* The optional second argument can be used to pass a default value that will be returned if the parsing of YAML string have failed. #### `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 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()` 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. ### `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'] ``` ### `private` Type: Ruby 3.x API **Deprecated:** Sets the current class or definition as private. Calling the class or definition from outside the current module will fail. #### `private()` The private function. Returns: `Any` Sets the current class or definition as private ### `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 type of hash to use. It will be converted into the appropriate crypt(3) hash specifier. Valid hash types are: |Hash type |Specifier| |---------------------|---------| |MD5 |1 | |SHA-256 |5 | |SHA-512 (recommended)|6 | The third argument to this function is the salt to use. -> *Note:*: this uses the Puppet Master's implementation of crypt(3). If your +> *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 type of hash to use. It will be converted into the appropriate crypt(3) hash specifier. Valid hash types are: |Hash type |Specifier| |---------------------|---------| |MD5 |1 | |SHA-256 |5 | |SHA-512 (recommended)|6 | The third argument to this function is the salt to use. -> *Note:*: this uses the Puppet Master's implementation of crypt(3). If your +> *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: `Hash` Provides a 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 !~ #### 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 !~ 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 ### `round` Type: Ruby 3.x API ```round(2.9)``` returns ```3``` ```round(2.4)``` returns ```2``` > *Note:* from Puppet 6.0.0, the compatible function with the same name in Puppet core will be used instead of this function. #### `round()` ```round(2.9)``` returns ```3``` ```round(2.4)``` returns ```2``` > *Note:* from Puppet 6.0.0, the compatible function with the same name in Puppet core will be used instead of this function. Returns: `Any` the rounded value as integer ### `rstrip` Type: Ruby 3.x API > *Note:* from Puppet 6.0.0, the compatible function with the same name in Puppet core will be used instead of this function. #### `rstrip()` > *Note:* from Puppet 6.0.0, the compatible function with the same name in Puppet core will be used instead of this function. Returns: `Any` the string with leading spaces removed ### `seeded_rand` Type: Ruby 3.x API Generates a random whole number greater than or equal to 0 and less than MAX, using the value of SEED for repeatable randomness. If SEED starts with "$fqdn:", this is behaves the same as `fqdn_rand`. #### Examples ##### **Usage:** ```puppet seeded_rand(MAX, SEED). MAX must be a positive integer; SEED is any string. ``` #### `seeded_rand()` Generates a random whole number greater than or equal to 0 and less than MAX, using the value of SEED for repeatable randomness. If SEED starts with "$fqdn:", this is behaves the same as `fqdn_rand`. Returns: `Any` random number greater than or equal to 0 and less than MAX ##### Examples ###### **Usage:** ```puppet seeded_rand(MAX, SEED). MAX must be a positive integer; SEED is any string. ``` ### `seeded_rand_string` Type: Ruby 4.x API Generates a consistent random string of specific length based on provided seed. #### Examples ##### Generate a consistently random string of length 8 with a seed: ```puppet seeded_rand_string(8, "${module_name}::redis_password") ``` ##### Generate a random string from a specific set of characters: ```puppet seeded_rand_string(5, '', 'abcdef') ``` #### `seeded_rand_string(Integer[1] $length, String $seed, Optional[String[2]] $charset)` The seeded_rand_string function. Returns: `String` Random string. ##### Examples ###### Generate a consistently random string of length 8 with a seed: ```puppet seeded_rand_string(8, "${module_name}::redis_password") ``` ###### Generate a random string from a specific set of characters: ```puppet seeded_rand_string(5, '', 'abcdef') ``` ##### `length` Data type: `Integer[1]` Length of string to be generated. ##### `seed` Data type: `String` Seed string. ##### `charset` Data type: `Optional[String[2]]` String that contains characters to use for the random string. ### `shell_escape` Type: Ruby 3.x API >* Note:* that the resulting string should be used unquoted and is not intended for use in double quotes nor in single quotes. This function behaves the same as ruby's Shellwords.shellescape() function. #### `shell_escape()` >* Note:* that the resulting string should be used unquoted and is not intended for use in double quotes nor in single quotes. This function behaves the same as ruby's Shellwords.shellescape() function. Returns: `Any` A string of characters with metacharacters converted to their escaped form. ### `shell_join` Type: Ruby 3.x API Builds a command line string from the given array of strings. Each array item is escaped for Bourne shell. All items are then joined together, with a single space in between. This function behaves the same as ruby's Shellwords.shelljoin() function #### `shell_join()` Builds a command line string from the given array of strings. Each array item is escaped for Bourne shell. All items are then joined together, with a single space in between. This function behaves the same as ruby's Shellwords.shelljoin() function Returns: `Any` a command line string ### `shell_split` Type: Ruby 3.x API This function behaves the same as ruby's Shellwords.shellsplit() function #### `shell_split()` This function behaves the same as ruby's Shellwords.shellsplit() function Returns: `Any` array of tokens ### `shuffle` Type: Ruby 3.x API @summary Randomizes the order of a string or array elements. #### `shuffle()` @summary Randomizes the order of a string or array elements. Returns: `Any` randomized string or array ### `size` Type: Ruby 3.x API > *Note:* that since Puppet 5.4.0, the length() function in Puppet is preferred over this. For versions of Puppet < 5.4.0 use the stdlib length() function. #### `size()` > *Note:* that since Puppet 5.4.0, the length() function in Puppet is preferred over this. For versions of Puppet < 5.4.0 use the stdlib length() function. Returns: `Any` the number of elements in a string, an array or a hash ### `sort` Type: Ruby 3.x API Note that from Puppet 6.0.0 the same function in Puppet will be used instead of this. #### `sort()` Note that from Puppet 6.0.0 the same function in Puppet will be used instead of this. Returns: `Any` sorted string or array ### `sprintf_hash` Type: Ruby 4.x API The first parameter is format string describing how the rest of the parameters in the hash should be formatted. See the documentation for the `Kernel::sprintf` function in Ruby for all the details. In the given argument hash with parameters, all keys are converted to symbols so they work with the `sprintf` function. Note that since Puppet 4.10.10, and 5.3.4 this functionality is supported by the `sprintf` function in puppet core. #### Examples ##### Format a string and number ```puppet $output = sprintf_hash('String: %s / number converted to binary: %b', { 'foo' => 'a string', 'number' => 5 }) # $output = 'String: a string / number converted to binary: 101' ``` #### `sprintf_hash(String $format, Hash $arguments)` The first parameter is format string describing how the rest of the parameters in the hash should be formatted. See the documentation for the `Kernel::sprintf` function in Ruby for all the details. In the given argument hash with parameters, all keys are converted to symbols so they work with the `sprintf` function. Note that since Puppet 4.10.10, and 5.3.4 this functionality is supported by the `sprintf` function in puppet core. Returns: `Any` The formatted string. ##### Examples ###### Format a string and number ```puppet $output = sprintf_hash('String: %s / number converted to binary: %b', { 'foo' => 'a string', 'number' => 5 }) # $output = 'String: a string / number converted to binary: 101' ``` ##### `format` Data type: `String` The format to use. ##### `arguments` Data type: `Hash` Hash with parameters. ### `squeeze` Type: Ruby 3.x API Returns a new string where runs of the same character that occur in this set are replaced by a single character. #### `squeeze()` The squeeze function. Returns: `Any` a new string where runs of the same character that occur in this set are replaced by a single character. ### `stdlib::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[1] $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[1]` The string to check ##### `suffixes` Data type: `Variant[String[1],Array[String[1], 1]]` The suffixes to check ### `stdlib::extname` Type: Ruby 4.x API If Path is a Dotfile, or starts with a Period, then the starting Dot is not dealt with the Start of the Extension. An empty String will also be returned, when the Period is the last Character in Path. #### Examples ##### Determining the Extension of a Filename ```puppet stdlib::extname('test.rb') => '.rb' stdlib::extname('a/b/d/test.rb') => '.rb' stdlib::extname('test') => '' stdlib::extname('.profile') => '' ``` #### `stdlib::extname(String $filename)` If Path is a Dotfile, or starts with a Period, then the starting Dot is not dealt with the Start of the Extension. An empty String will also be returned, when the Period is the last Character in Path. Returns: `String` The Extension starting from the last Period ##### Examples ###### Determining the Extension of a Filename ```puppet stdlib::extname('test.rb') => '.rb' stdlib::extname('a/b/d/test.rb') => '.rb' stdlib::extname('test') => '' stdlib::extname('.profile') => '' ``` ##### `filename` Data type: `String` The Filename ### `stdlib::ip_in_range` Type: Ruby 4.x API Returns true if the ipaddress is within the given CIDRs #### Examples ##### ip_in_range(, ) ```puppet stdlib::ip_in_range('10.10.10.53', '10.10.10.0/24') => true ``` #### `stdlib::ip_in_range(String $ipaddress, Variant[String, Array] $range)` The stdlib::ip_in_range function. Returns: `Boolean` True or False ##### Examples ###### ip_in_range(, ) ```puppet stdlib::ip_in_range('10.10.10.53', '10.10.10.0/24') => true ``` ##### `ipaddress` Data type: `String` The IP address to check ##### `range` Data type: `Variant[String, Array]` One CIDR or an array of CIDRs defining the range(s) to check against ### `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[1] $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[1]` The string to check ##### `prefixes` Data type: `Variant[String[1],Array[String[1], 1]]` The prefixes to check. ### `str2bool` Type: Ruby 3.x API > *Note:* that since Puppet 5.0.0 the Boolean data type can convert strings to a Boolean value. See the function new() in Puppet for details what the Boolean data type supports. #### `str2bool()` > *Note:* that since Puppet 5.0.0 the Boolean data type can convert strings to a Boolean value. See the function new() in Puppet for details what the Boolean data type supports. Returns: `Any` This attempt to convert to boolean strings that contain things like: Y,y, 1, T,t, TRUE,true to 'true' and strings that contain things like: 0, F,f, N,n, false, FALSE, no to 'false'. ### `str2saltedpbkdf2` Type: Ruby 3.x API Convert a string into a salted SHA512 PBKDF2 password hash like requred for OS X / macOS 10.8+. Note, however, that Apple changes what's required periodically and this may not work for the latest version of macOS. If that is the case you should get a helpful error message when Puppet tries to set the pasword using the parameters you provide to the user resource. #### Examples ##### Plain text password and salt ```puppet $pw_info = str2saltedpbkdf2('Pa55w0rd', 'Using s0m3 s@lt', 50000) user { 'jdoe': ensure => present, iterations => $pw_info['interations'], password => $pw_info['password_hex'], salt => $pw_info['salt_hex'], } ``` ##### Sensitive password and salt ```puppet $pw = Sensitive.new('Pa55w0rd') $salt = Sensitive.new('Using s0m3 s@lt') $pw_info = Sensitive.new(str2saltedpbkdf2($pw, $salt, 50000)) user { 'jdoe': ensure => present, iterations => unwrap($pw_info)['interations'], password => unwrap($pw_info)['password_hex'], salt => unwrap($pw_info)['salt_hex'], } ``` #### `str2saltedpbkdf2()` Convert a string into a salted SHA512 PBKDF2 password hash like requred for OS X / macOS 10.8+. Note, however, that Apple changes what's required periodically and this may not work for the latest version of macOS. If that is the case you should get a helpful error message when Puppet tries to set the pasword using the parameters you provide to the user resource. Returns: `Hash` Provides a hash containing the hex version of the password, the hex version of the salt, and iterations. ##### Examples ###### Plain text password and salt ```puppet $pw_info = str2saltedpbkdf2('Pa55w0rd', 'Using s0m3 s@lt', 50000) user { 'jdoe': ensure => present, iterations => $pw_info['interations'], password => $pw_info['password_hex'], salt => $pw_info['salt_hex'], } ``` ###### Sensitive password and salt ```puppet $pw = Sensitive.new('Pa55w0rd') $salt = Sensitive.new('Using s0m3 s@lt') $pw_info = Sensitive.new(str2saltedpbkdf2($pw, $salt, 50000)) user { 'jdoe': ensure => present, iterations => unwrap($pw_info)['interations'], password => unwrap($pw_info)['password_hex'], salt => unwrap($pw_info)['salt_hex'], } ``` ### `str2saltedsha512` Type: Ruby 3.x API Given any simple string, you will get a hex version of a salted-SHA512 password hash that can be inserted into your Puppet manifests as a valid password attribute. #### `str2saltedsha512()` Given any simple string, you will get a hex version of a salted-SHA512 password hash that can be inserted into your Puppet manifests as a valid password attribute. Returns: `Any` converted string as a hex version of a salted-SHA512 password hash ### `strip` Type: Ruby 3.x API > *Note:*: from Puppet 6.0.0, the compatible function with the same name in Puppet core will be used instead of this function. #### Examples ##### **Usage** ```puppet strip(" aaa ") Would result in: "aaa" ``` #### `strip()` > *Note:*: from Puppet 6.0.0, the compatible function with the same name in Puppet core will be used instead of this function. Returns: `Any` String or Array converted ##### Examples ###### **Usage** ```puppet strip(" aaa ") Would result in: "aaa" ``` ### `suffix` Type: Ruby 3.x API > *Note:* that since Puppet 4.0.0 the general way to modify values is in array is by using the map function in Puppet. This example does the same as the example above: ```['a', 'b', 'c'].map |$x| { "${x}p" }``` #### Examples ##### **Usage** ```puppet suffix(['a','b','c'], 'p') Will return: ['ap','bp','cp'] ``` #### `suffix()` > *Note:* that since Puppet 4.0.0 the general way to modify values is in array is by using the map function in Puppet. This example does the same as the example above: ```['a', 'b', 'c'].map |$x| { "${x}p" }``` Returns: `Any` Array or Hash with updated elements containing the passed suffix ##### Examples ###### **Usage** ```puppet suffix(['a','b','c'], 'p') Will return: ['ap','bp','cp'] ``` ### `swapcase` Type: Ruby 3.x API This function will swap the existing case of a string. #### Examples ##### **Usage** ```puppet swapcase("aBcD") Would result in: "AbCd" ``` #### `swapcase()` The swapcase function. Returns: `Any` string with uppercase alphabetic characters converted to lowercase and lowercase characters converted to uppercase ##### Examples ###### **Usage** ```puppet swapcase("aBcD") Would result in: "AbCd" ``` ### `time` Type: Ruby 3.x API > *Note:* that since Puppet 4.8.0 the Puppet language has the data types Timestamp (a point in time) and Timespan (a duration). The following example is equivalent to calling time() without any arguments: ```Timestamp()``` #### Examples ##### **Usage** ```puppet time() Will return something like: 1311972653 ``` #### `time()` > *Note:* that since Puppet 4.8.0 the Puppet language has the data types Timestamp (a point in time) and Timespan (a duration). The following example is equivalent to calling time() without any arguments: ```Timestamp()``` Returns: `Any` the current time since epoch as an integer. ##### Examples ###### **Usage** ```puppet time() Will return something like: 1311972653 ``` ### `to_bytes` Type: Ruby 3.x API Takes a single string value as an argument. These conversions reflect a layperson's understanding of 1 MB = 1024 KB, when in fact 1 MB = 1000 KB, and 1 MiB = 1024 KiB. #### `to_bytes()` Takes a single string value as an argument. These conversions reflect a layperson's understanding of 1 MB = 1024 KB, when in fact 1 MB = 1000 KB, and 1 MiB = 1024 KiB. Returns: `Any` converted value into bytes ### `to_json` Type: Ruby 4.x API Convert a data structure and output to JSON #### Examples ##### how to output JSON ```puppet # output json to a file file { '/tmp/my.json': ensure => file, content => to_json($myhash), } ``` #### `to_json(Any $data)` The to_json function. Returns: `Any` converted data to json ##### Examples ###### how to output JSON ```puppet # output json to a file file { '/tmp/my.json': ensure => file, content => to_json($myhash), } ``` ##### `data` Data type: `Any` data structure which needs to be converted into JSON ### `to_json_pretty` Type: Ruby 4.x API Convert data structure and output to pretty JSON #### Examples ##### **Usage** ```puppet * how to output pretty JSON to file file { '/tmp/my.json': ensure => file, content => to_json_pretty($myhash), } * how to output pretty JSON skipping over keys with undef values file { '/tmp/my.json': ensure => file, content => to_json_pretty({ param_one => 'value', param_two => undef, }, true), } * how to output pretty JSON using tabs for indentation file { '/tmp/my.json': ensure => file, content => to_json_pretty({ param_one => 'value', param_two => { param_more => 42, }, }, nil, {indent => ' '}), } ``` #### `to_json_pretty(Variant[Hash, Array] $data, Optional[Optional[Boolean]] $skip_undef, Optional[Struct[{ indent => Optional[String], space => Optional[String], space_before => Optional[String], object_nl => Optional[String], array_nl => Optional[String], allow_nan => Optional[Boolean], max_nesting => Optional[Integer[-1,default]], }]] $opts)` The to_json_pretty function. Returns: `Any` converted data to pretty json ##### Examples ###### **Usage** ```puppet * how to output pretty JSON to file file { '/tmp/my.json': ensure => file, content => to_json_pretty($myhash), } * how to output pretty JSON skipping over keys with undef values file { '/tmp/my.json': ensure => file, content => to_json_pretty({ param_one => 'value', param_two => undef, }, true), } * how to output pretty JSON using tabs for indentation file { '/tmp/my.json': ensure => file, content => to_json_pretty({ param_one => 'value', param_two => { param_more => 42, }, }, nil, {indent => ' '}), } ``` ##### `data` Data type: `Variant[Hash, Array]` data structure which needs to be converted to pretty json ##### `skip_undef` Data type: `Optional[Optional[Boolean]]` value `true` or `false` ##### `opts` Data type: `Optional[Struct[{ indent => Optional[String], space => Optional[String], space_before => Optional[String], object_nl => Optional[String], array_nl => Optional[String], allow_nan => Optional[Boolean], max_nesting => Optional[Integer[-1,default]], }]]` hash-map of settings passed to JSON.pretty_generate, see https://ruby-doc.org/stdlib-2.0.0/libdoc/json/rdoc/JSON.html#method-i-generate. Note that `max_nesting` doesn't take the value `false`; use `-1` instead. ### `to_yaml` Type: Ruby 4.x API Convert a data structure and output it as YAML #### Examples ##### how to output YAML ```puppet # output yaml to a file file { '/tmp/my.yaml': ensure => file, content => to_yaml($myhash), } ``` #### `to_yaml(Any $data)` The to_yaml function. Returns: `String` ##### Examples ###### how to output YAML ```puppet # output yaml to a file file { '/tmp/my.yaml': ensure => file, content => to_yaml($myhash), } ``` ##### `data` Data type: `Any` ### `try_get_value` Type: Ruby 3.x API Key can contain slashes to describe path components. The function will go down the structure and try to extract the required value. `` $data = { 'a' => { 'b' => [ 'b1', 'b2', 'b3', ] } } $value = try_get_value($data, 'a/b/2', 'not_found', '/') => $value = 'b3' ``` ``` a -> first hash key b -> second hash key 2 -> array index starting with 0 not_found -> (optional) will be returned if there is no value or the path did not match. Defaults to nil. / -> (optional) path delimiter. Defaults to '/'. ``` In addition to the required "key" argument, "try_get_value" accepts default argument. It will be returned if no value was found or a path component is missing. And the fourth argument can set a variable path separator. #### `try_get_value()` Key can contain slashes to describe path components. The function will go down the structure and try to extract the required value. `` $data = { 'a' => { 'b' => [ 'b1', 'b2', 'b3', ] } } $value = try_get_value($data, 'a/b/2', 'not_found', '/') => $value = 'b3' ``` ``` a -> first hash key b -> second hash key 2 -> array index starting with 0 not_found -> (optional) will be returned if there is no value or the path did not match. Defaults to nil. / -> (optional) path delimiter. Defaults to '/'. ``` In addition to the required "key" argument, "try_get_value" accepts default argument. It will be returned if no value was found or a path component is missing. And the fourth argument can set a variable path separator. Returns: `Any` Looks up into a complex structure of arrays and hashes and returns a value or the default value if nothing was found. ### `type` Type: Ruby 3.x API please use type3x() before upgrading to Puppet 4 for backwards-compatibility, or migrate to the new parser's typing system. * string * array * hash * float * integer * boolean #### `type()` please use type3x() before upgrading to Puppet 4 for backwards-compatibility, or migrate to the new parser's typing system. * string * array * hash * float * integer * boolean Returns: `Any` the type when passed a value. Type can be one of: ### `type3x` Type: Ruby 3.x API * string * array * hash * float * integer * boolean #### `type3x()` * string * array * hash * float * integer * boolean Returns: `Any` the type when passed a value. Type can be one of: ### `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 type_of($first_value) != type_of($second_value) { fail("first_value and second_value are different types") } ``` ##### how to compare against an abstract type ```puppet unless type_of($first_value) <= Numeric { fail("first_value must be Numeric") } unless type_of{$first_value) <= Collection[1] { fail("first_value must be an Array or Hash, and contain at least one element") } ``` #### `type_of(Any $value)` 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 type_of($first_value) != type_of($second_value) { fail("first_value and second_value are different types") } ``` ###### how to compare against an abstract type ```puppet unless type_of($first_value) <= Numeric { fail("first_value must be Numeric") } unless type_of{$first_value) <= Collection[1] { fail("first_value must be an Array or Hash, and contain at least one element") } ``` ##### `value` Data type: `Any` ### `union` Type: Ruby 3.x API This function returns a union of two or more arrays. #### Examples ##### **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"] ``` ### `unique` Type: Ruby 3.x API This function will remove duplicates from strings and arrays. #### Examples ##### **Usage** ```puppet unique("aabbcc") Will return: abc You can also use this with arrays: unique(["a","a","b","b","c","c"]) This returns: ["a","b","c"] ``` #### `unique()` The unique function. Returns: `Any` String or array with duplicates removed ##### Examples ###### **Usage** ```puppet unique("aabbcc") Will return: abc You can also use this with arrays: unique(["a","a","b","b","c","c"]) This returns: ["a","b","c"] ``` ### `unix2dos` Type: Ruby 3.x API Takes a single string argument. #### `unix2dos()` Takes a single string argument. Returns: `Any` the DOS version of the given string. ### `upcase` Type: Ruby 3.x API > *Note:* from Puppet 6.0.0, the compatible function with the same name in Puppet core will be used instead of this function. #### Examples ##### **Usage** ```puppet upcase("abcd") Will return ABCD ``` #### `upcase()` > *Note:* from Puppet 6.0.0, the compatible function with the same name in Puppet core will be used instead of this function. Returns: `Any` converted string ot array of strings to uppercase ##### Examples ###### **Usage** ```puppet upcase("abcd") Will return ABCD ``` ### `uriescape` Type: Ruby 3.x API Urlencodes a string or array of strings. Requires either a single string or an array as an input. #### `uriescape()` The uriescape function. Returns: `String` a string that contains the converted value ### `validate_absolute_path` Type: Ruby 3.x API Validate the string represents an absolute path in the filesystem. This function works for windows and unix style paths. #### Examples ##### **Usage** ```puppet The following values will pass: $my_path = 'C:/Program Files (x86)/Puppet Labs/Puppet' validate_absolute_path($my_path) $my_path2 = '/var/lib/puppet' validate_absolute_path($my_path2) $my_path3 = ['C:/Program Files (x86)/Puppet Labs/Puppet','C:/Program Files/Puppet Labs/Puppet'] validate_absolute_path($my_path3) $my_path4 = ['/var/lib/puppet','/usr/share/puppet'] validate_absolute_path($my_path4) The following values will fail, causing compilation to abort: validate_absolute_path(true) validate_absolute_path('../var/lib/puppet') validate_absolute_path('var/lib/puppet') validate_absolute_path([ 'var/lib/puppet', '/var/foo' ]) validate_absolute_path([ '/var/lib/puppet', 'var/foo' ]) $undefined = undef validate_absolute_path($undefin ``` #### `validate_absolute_path()` The validate_absolute_path function. Returns: `Any` passes when the string is an absolute path or raise an error when it is not and fails compilation ##### Examples ###### **Usage** ```puppet The following values will pass: $my_path = 'C:/Program Files (x86)/Puppet Labs/Puppet' validate_absolute_path($my_path) $my_path2 = '/var/lib/puppet' validate_absolute_path($my_path2) $my_path3 = ['C:/Program Files (x86)/Puppet Labs/Puppet','C:/Program Files/Puppet Labs/Puppet'] validate_absolute_path($my_path3) $my_path4 = ['/var/lib/puppet','/usr/share/puppet'] validate_absolute_path($my_path4) The following values will fail, causing compilation to abort: validate_absolute_path(true) validate_absolute_path('../var/lib/puppet') validate_absolute_path('var/lib/puppet') validate_absolute_path([ 'var/lib/puppet', '/var/foo' ]) validate_absolute_path([ '/var/lib/puppet', 'var/foo' ]) $undefined = undef validate_absolute_path($undefin ``` ### `validate_absolute_path` Type: Ruby 4.x API Validate the string represents an absolute path in the filesystem. #### `validate_absolute_path(Any $scope, Any *$args)` The validate_absolute_path function. Returns: `Boolean` A boolean value returned from the called function. ##### `scope` Data type: `Any` The main value that will be passed to the method ##### `*args` Data type: `Any` Any additional values that are to be passed to the method ### `validate_array` Type: Ruby 3.x API Validate that all passed values are array data structures. Abort catalog compilation if any value fails this check. #### Examples ##### **Usage** ```puppet The following values will pass: $my_array = [ 'one', 'two' ] 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 ``` #### `validate_array()` The validate_array function. Returns: `Any` validate array ##### Examples ###### **Usage** ```puppet 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 ``` ### `validate_array` Type: Ruby 4.x API Validate the passed value represents an array. #### `validate_array(Any $scope, Any *$args)` The validate_array function. Returns: `Any` A boolean value (`true` or `false`) returned from the called function. ##### `scope` Data type: `Any` The main value that will be passed to the method ##### `*args` Data type: `Any` Any additional values that are to be passed to the method ### `validate_augeas` Type: Ruby 3.x API 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_bool` Type: Ruby 3.x API Validate that all passed values are either true or false. Abort catalog compilation if any value fails this check. #### Examples ##### **Usage** ```puppet 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) ``` #### `validate_bool()` The validate_bool function. Returns: `Any` validate boolean ##### Examples ###### **Usage** ```puppet 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) ``` ### `validate_bool` Type: Ruby 4.x API Validate the passed value represents a boolean. #### `validate_bool(Any $scope, Any *$args)` The validate_bool function. Returns: `Boolean` `true` or `false` A boolean value returned from the called function. ##### `scope` Data type: `Any` The main value that will be passed to the method ##### `*args` Data type: `Any` Any additional values that are to be passed to the method ### `validate_cmd` Type: Ruby 3.x API 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 3.x API Validate that all values passed are syntactically correct domain names. Fail compilation if any value fails this check. #### Examples ##### **Usage** ```puppet The following values will pass: $my_domain_name = 'server.domain.tld' validate_domain_name($my_domain_name) validate_domain_name('domain.tld', 'puppet.com', $my_domain_name) The following values will fail, causing compilation to abort: validate_domain_name(1) validate_domain_name(true) validate_domain_name('invalid domain') validate_domain_name('-foo.example.com') validate_domain_name('www.example.2com') ``` #### `validate_domain_name()` The validate_domain_name function. Returns: `Any` passes when the given values are syntactically correct domain names or raise an error when they are not and fails compilation ##### Examples ###### **Usage** ```puppet The following values will pass: $my_domain_name = 'server.domain.tld' validate_domain_name($my_domain_name) validate_domain_name('domain.tld', 'puppet.com', $my_domain_name) The following values will fail, causing compilation to abort: validate_domain_name(1) validate_domain_name(true) validate_domain_name('invalid domain') validate_domain_name('-foo.example.com') validate_domain_name('www.example.2com') ``` ### `validate_email_address` Type: Ruby 3.x API Validate that all values passed are valid email addresses. Fail compilation if any value fails this check. #### Examples ##### **Usage** ```puppet The following values will pass: $my_email = "waldo@gmail.com" validate_email_address($my_email) validate_email_address("bob@gmail.com", "alice@gmail.com", $my_email) The following values will fail, causing compilation to abort: $some_array = [ 'bad_email@/d/efdf.com' ] validate_email_address($some_array) ``` #### `validate_email_address()` The validate_email_address function. Returns: `Any` Fail compilation if any value fails this check. ##### Examples ###### **Usage** ```puppet The following values will pass: $my_email = "waldo@gmail.com" validate_email_address($my_email) validate_email_address("bob@gmail.com", "alice@gmail.com", $my_email) The following values will fail, causing compilation to abort: $some_array = [ 'bad_email@/d/efdf.com' ] validate_email_address($some_array) ``` ### `validate_hash` Type: Ruby 3.x API Validate that all passed values are hash data structures. Abort catalog compilation if any value fails this check. #### Examples ##### **Usage** ```puppet The following values will pass: $my_hash = { 'one' => 'two' } validate_hash($my_hash) The following values will fail, causing compilation to abort: validate_hash(true) validate_hash('some_string') $undefined = undef validate_hash($undefined) ``` #### `validate_hash()` The validate_hash function. Returns: `Any` validate hash ##### Examples ###### **Usage** ```puppet The following values will pass: $my_hash = { 'one' => 'two' } validate_hash($my_hash) The following values will fail, causing compilation to abort: validate_hash(true) validate_hash('some_string') $undefined = undef validate_hash($undefined) ``` ### `validate_hash` Type: Ruby 4.x API Validate the passed value represents a hash. #### `validate_hash(Any $scope, Any *$args)` The validate_hash function. Returns: `Any` A boolean value (`true` or `false`) returned from the called function. ##### `scope` Data type: `Any` The main value that will be passed to the method ##### `*args` Data type: `Any` Any additional values that are to be passed to the method ### `validate_integer` Type: Ruby 3.x API The second argument is optional and passes a maximum. (All elements of) the first argument has to be less or equal to this max. The third argument is optional and passes a minimum. (All elements of) the first argument has to be greater or equal to this min. If, and only if, a minimum is given, the second argument may be an empty string or undef, which will be handled to just check if (all elements of) the first argument are greater or equal to the given minimum. It will fail if the first argument is not an integer or array of integers, and if arg 2 and arg 3 are not convertable to an integer. #### Examples ##### **Usage** ```puppet The following values will pass: validate_integer(1) validate_integer(1, 2) validate_integer(1, 1) validate_integer(1, 2, 0) validate_integer(2, 2, 2) validate_integer(2, '', 0) validate_integer(2, undef, 0) $foo = undef validate_integer(2, $foo, 0) validate_integer([1,2,3,4,5], 6) validate_integer([1,2,3,4,5], 6, 0) Plus all of the above, but any combination of values passed as strings ('1' or "1"). Plus all of the above, but with (correct) combinations of negative integer values. The following values will not: validate_integer(true) validate_integer(false) validate_integer(7.0) validate_integer({ 1 => 2 }) $foo = undef validate_integer($foo) validate_integer($foobaridontexist) validate_integer(1, 0) validate_integer(1, true) validate_integer(1, '') validate_integer(1, undef) validate_integer(1, , 0) validate_integer(1, 2, 3) validate_integer(1, 3, 2) validate_integer(1, 3, true) Plus all of the above, but any combination of values passed as strings ('false' or "false"). Plus all of the above, but with incorrect combinations of negative integer values. Plus all of the above, but with non-integer items in arrays or maximum / minimum argument. ``` #### `validate_integer()` The second argument is optional and passes a maximum. (All elements of) the first argument has to be less or equal to this max. The third argument is optional and passes a minimum. (All elements of) the first argument has to be greater or equal to this min. If, and only if, a minimum is given, the second argument may be an empty string or undef, which will be handled to just check if (all elements of) the first argument are greater or equal to the given minimum. It will fail if the first argument is not an integer or array of integers, and if arg 2 and arg 3 are not convertable to an integer. Returns: `Any` Validate that the first argument is an integer (or an array of integers). Fail compilation if any of the checks fail. ##### Examples ###### **Usage** ```puppet The following values will pass: validate_integer(1) validate_integer(1, 2) validate_integer(1, 1) validate_integer(1, 2, 0) validate_integer(2, 2, 2) validate_integer(2, '', 0) validate_integer(2, undef, 0) $foo = undef validate_integer(2, $foo, 0) validate_integer([1,2,3,4,5], 6) validate_integer([1,2,3,4,5], 6, 0) Plus all of the above, but any combination of values passed as strings ('1' or "1"). Plus all of the above, but with (correct) combinations of negative integer values. The following values will not: validate_integer(true) validate_integer(false) validate_integer(7.0) validate_integer({ 1 => 2 }) $foo = undef validate_integer($foo) validate_integer($foobaridontexist) validate_integer(1, 0) validate_integer(1, true) validate_integer(1, '') validate_integer(1, undef) validate_integer(1, , 0) validate_integer(1, 2, 3) validate_integer(1, 3, 2) validate_integer(1, 3, true) Plus all of the above, but any combination of values passed as strings ('false' or "false"). Plus all of the above, but with incorrect combinations of negative integer values. Plus all of the above, but with non-integer items in arrays or maximum / minimum argument. ``` ### `validate_integer` Type: Ruby 4.x API Validate the passed value represents an integer. #### `validate_integer(Any $scope, Any *$args)` The validate_integer function. Returns: `Boolean` `true` or `false` A boolean value returned from the called function. ##### `scope` Data type: `Any` The main value that will be passed to the method ##### `*args` Data type: `Any` Any additional values that are to be passed to the method ### `validate_ip_address` Type: Ruby 3.x API Validate that all values passed are valid IP addresses, regardless they are IPv4 or IPv6 Fail compilation if any value fails this check. #### Examples ##### **Usage** ```puppet The following values will pass: $my_ip = "1.2.3.4" validate_ip_address($my_ip) validate_ip_address("8.8.8.8", "172.16.0.1", $my_ip) $my_ip = "3ffe:505:2" validate_ip_address(1) validate_ip_address($my_ip) validate_ip_address("fe80::baf6:b1ff:fe19:7507", $my_ip) The following values will fail, causing compilation to abort: $some_array = [ 1, true, false, "garbage string", "3ffe:505:2" ] validate_ip_address($some_array) ``` #### `validate_ip_address()` The validate_ip_address function. Returns: `Any` passes when the given values are valid IP addresses or raise an error when they are not and fails compilation ##### Examples ###### **Usage** ```puppet The following values will pass: $my_ip = "1.2.3.4" validate_ip_address($my_ip) validate_ip_address("8.8.8.8", "172.16.0.1", $my_ip) $my_ip = "3ffe:505:2" validate_ip_address(1) validate_ip_address($my_ip) validate_ip_address("fe80::baf6:b1ff:fe19:7507", $my_ip) The following values will fail, causing compilation to abort: $some_array = [ 1, true, false, "garbage string", "3ffe:505:2" ] validate_ip_address($some_array) ``` ### `validate_ip_address` Type: Ruby 4.x API Validate the passed value represents an ip_address. #### `validate_ip_address(Any $scope, Any *$args)` The validate_ip_address function. Returns: `Boolean` `true` or `false` A boolean value returned from the called function. ##### `scope` Data type: `Any` The main value that will be passed to the method ##### `*args` Data type: `Any` Any additional values that are to be passed to the method ### `validate_ipv4_address` Type: Ruby 4.x API Validate the passed value represents an ipv4_address. #### `validate_ipv4_address(Any $scope, Any *$args)` The validate_ipv4_address function. Returns: `Boolean` `true` or `false` A boolean value returned from the called function. ##### `scope` Data type: `Any` The main value that will be passed to the method ##### `*args` Data type: `Any` Any additional values that are to be passed to the method ### `validate_ipv4_address` Type: Ruby 3.x API Validate that all values passed are valid IPv4 addresses. Fail compilation if any value fails this check. #### Examples ##### **Usage** ```puppet The following values will pass: $my_ip = "1.2.3.4" validate_ipv4_address($my_ip) validate_ipv4_address("8.8.8.8", "172.16.0.1", $my_ip) The following values will fail, causing compilation to abort: $some_array = [ 1, true, false, "garbage string", "3ffe:505:2" ] validate_ipv4_address($some_array) ``` #### `validate_ipv4_address()` The validate_ipv4_address function. Returns: `Any` passes when the given values are valid IPv4 addresses or raise an error when they are not and fails compilation ##### Examples ###### **Usage** ```puppet The following values will pass: $my_ip = "1.2.3.4" validate_ipv4_address($my_ip) validate_ipv4_address("8.8.8.8", "172.16.0.1", $my_ip) The following values will fail, causing compilation to abort: $some_array = [ 1, true, false, "garbage string", "3ffe:505:2" ] validate_ipv4_address($some_array) ``` ### `validate_ipv6_address` Type: Ruby 3.x API Validate that all values passed are valid IPv6 addresses. Fail compilation if any value fails this check. #### Examples ##### **Usage** ```puppet The following values will pass: $my_ip = "3ffe:505:2" validate_ipv6_address(1) validate_ipv6_address($my_ip) validate_bool("fe80::baf6:b1ff:fe19:7507", $my_ip) The following values will fail, causing compilation to abort: $some_array = [ true, false, "garbage string", "1.2.3.4" ] validate_ipv6_address($some_array) ``` #### `validate_ipv6_address()` The validate_ipv6_address function. Returns: `Any` passes when the given values are valid IPv6 addresses or raise an error when they are not and fails compilation ##### Examples ###### **Usage** ```puppet The following values will pass: $my_ip = "3ffe:505:2" validate_ipv6_address(1) validate_ipv6_address($my_ip) validate_bool("fe80::baf6:b1ff:fe19:7507", $my_ip) The following values will fail, causing compilation to abort: $some_array = [ true, false, "garbage string", "1.2.3.4" ] validate_ipv6_address($some_array) ``` ### `validate_ipv6_address` Type: Ruby 4.x API Validate the passed value represents an ipv6_address. #### `validate_ipv6_address(Any $scope, Any *$args)` The validate_ipv6_address function. Returns: `Boolean` `true` or `false` A boolean value returned from the called function. ##### `scope` Data type: `Any` The main value that will be passed to the method ##### `*args` Data type: `Any` Any additional values that are to be passed to the method ### `validate_legacy` Type: Ruby 4.x API Validate a value against both the target_type (new) and the previous_validation function (old). #### `validate_legacy(Any $scope, Type $target_type, String $function_name, Any $value, Any *$args)` The function checks a value against both the target_type (new) and the previous_validation function (old). Returns: `Any` 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` ##### `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` ##### `value` Data type: `Any` ##### `*args` Data type: `Any` Any additional values that are to be passed to the method ### `validate_numeric` Type: Ruby 3.x API The second argument is optional and passes a maximum. (All elements of) the first argument has to be less or equal to this max. The third argument is optional and passes a minimum. (All elements of) the first argument has to be greater or equal to this min. If, and only if, a minimum is given, the second argument may be an empty string or undef, which will be handled to just check if (all elements of) the first argument are greater or equal to the given minimum. It will fail if the first argument is not a numeric (Integer or Float) or array of numerics, and if arg 2 and arg 3 are not convertable to a numeric. For passing and failing usage, see `validate_integer()`. It is all the same for validate_numeric, yet now floating point values are allowed, too. #### `validate_numeric()` The second argument is optional and passes a maximum. (All elements of) the first argument has to be less or equal to this max. The third argument is optional and passes a minimum. (All elements of) the first argument has to be greater or equal to this min. If, and only if, a minimum is given, the second argument may be an empty string or undef, which will be handled to just check if (all elements of) the first argument are greater or equal to the given minimum. It will fail if the first argument is not a numeric (Integer or Float) or array of numerics, and if arg 2 and arg 3 are not convertable to a numeric. For passing and failing usage, see `validate_integer()`. It is all the same for validate_numeric, yet now floating point values are allowed, too. Returns: `Any` Validate that the first argument is a numeric value (or an array of numeric values). Fail compilation if any of the checks fail. ### `validate_numeric` Type: Ruby 4.x API Validate the passed value represents a numeric value. #### `validate_numeric(Any $scope, Any *$args)` The validate_numeric function. Returns: `Boolean` `true` or `false` A boolean value returned from the called function. ##### `scope` Data type: `Any` The main value that will be passed to the method ##### `*args` Data type: `Any` Any additional values that are to be passed to the method ### `validate_re` Type: Ruby 3.x API The first argument of this function should be a string to test, and the second argument should be a stringified regular expression (without the // delimiters) or an array of regular expressions. If none of the regular expressions match the string passed in, compilation will abort with a parse error. If a third argument is specified, this will be the error message raised and seen by the user. > *Note:* Compilation will also abort, if the first argument is not a String. Always use quotes to force stringification: validate_re("${::operatingsystemmajrelease}", '^[57]$') #### Examples ##### **Usage** ```puppet The following strings will validate against the regular expressions: validate_re('one', '^one$') 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') ``` #### `validate_re()` The first argument of this function should be a string to test, and the second argument should be a stringified regular expression (without the // delimiters) or an array of regular expressions. If none of the regular expressions match the string passed in, compilation will abort with a parse error. If a third argument is specified, this will be the error message raised and seen by the user. > *Note:* Compilation will also abort, if the first argument is not a String. Always use quotes to force stringification: validate_re("${::operatingsystemmajrelease}", '^[57]$') Returns: `Any` validation of a string against one or more regular expressions. ##### Examples ###### **Usage** ```puppet The following strings will validate against the regular expressions: validate_re('one', '^one$') 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') ``` ### `validate_re` Type: Ruby 4.x API Perform validation of a string against one or more regular expressions. #### `validate_re(Any $scope, Any *$args)` The validate_re function. Returns: `Boolean` `true` or `false` returned from the called function. ##### `scope` Data type: `Any` The main value that will be passed to the method ##### `*args` Data type: `Any` Any additional values that are to be passed to the method The first argument of this function should be a string to test, and the second argument should be a stringified regular expression (without the // delimiters) or an array of regular expressions ### `validate_slength` Type: Ruby 3.x API Validate that the first argument is a string (or an array of strings), and less/equal to than the length of the second argument. An optional third parameter can be given the minimum length. It fails if the first argument is not a string or array of strings, and if arg 2 and arg 3 are not convertable to a number. #### Examples ##### **Usage** ```puppet 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) ``` #### `validate_slength()` The validate_slength function. Returns: `Any` validate that the first argument is a string (or an array of strings), and less/equal to than the length of the second argument. Fail compilation if any of the checks fail. ##### Examples ###### **Usage** ```puppet The following values will pass: validate_slength("discombobulate",17) validate_slength(["discombobulate","moo"],17) validate_slength(["discombobulate","moo"],17,3) The following valueis will not: validate_slength("discombobulate",1) validate_slength(["discombobulate","thermometer"],5) validate_slength(["discombobulate","moo"],17,10) ``` ### `validate_slength` Type: Ruby 4.x API Validate that a passed string has length less/equal with the passed value #### `validate_slength(Any $scope, Any *$args)` Validate that a passed string has length less/equal with the passed value Returns: `Boolean` `true` or `false` A boolean value returned from the called function. ##### `scope` Data type: `Any` The main value that will be passed to the method ##### `*args` Data type: `Any` Any additional values that are to be passed to the method ### `validate_string` Type: Ruby 3.x API > *Note:* Validate_string(undef) will not fail in this version of the functions API (incl. current and future parser). Instead, use: ``` if $var == undef { fail('...') } ``` #### Examples ##### **Usage** ```puppet The following values will pass: $my_string = "one two" validate_string($my_string, 'three') The following values will fail, causing compilation to abort: validate_string(true) validate_string([ 'some', 'array' ]) ``` #### `validate_string()` > *Note:* Validate_string(undef) will not fail in this version of the functions API (incl. current and future parser). Instead, use: ``` if $var == undef { fail('...') } ``` Returns: `Any` Validate that all passed values are string data structures. Failed compilation if any value fails this check. ##### Examples ###### **Usage** ```puppet 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' ]) ``` ### `validate_string` Type: Ruby 4.x API Validate that all passed values are string data structures. #### `validate_string(Any $scope, Any *$args)` The validate_string function. Returns: `Boolean` `true` or `false` A boolean value returned from the called function. ##### `scope` Data type: `Any` The main value that will be passed to the method ##### `*args` Data type: `Any` Any additional values that are to be passed to the method ### `validate_x509_rsa_key_pair` Type: Ruby 3.x API ```validate_x509_rsa_key_pair($cert, $key)``` #### `validate_x509_rsa_key_pair()` ```validate_x509_rsa_key_pair($cert, $key)``` Returns: `Any` Fail compilation if any value fails this check. ### `values` Type: Ruby 3.x API > *Note:* From Puppet 5.5.0, the compatible function with the same name in Puppet core will be used instead of this function. #### Examples ##### **Usage** ```puppet $hash = { 'a' => 1, 'b' => 2, 'c' => 3, } values($hash) This example would return: ```[1,2,3]``` ``` #### `values()` > *Note:* From Puppet 5.5.0, the compatible function with the same name in Puppet core will be used instead of this function. Returns: `Any` array of values ##### Examples ###### **Usage** ```puppet $hash = { 'a' => 1, 'b' => 2, 'c' => 3, } values($hash) This example would return: ```[1,2,3]``` ``` ### `values_at` Type: Ruby 3.x API 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::Compat::Absolute_path` Emulate the is_absolute_path and validate_absolute_path functions The first pattern is originally from is_absolute_path, which had it from 2.7.x's lib/puppet/util.rb Puppet::Util.absolute_path? slash = '[\\\\/]' name = '[^\\\\/]+' %r!^(([A-Z]:#{slash})|(#{slash}#{slash}#{name}#{slash}#{name})|(#{slash}#{slash}\?#{slash}#{name}))!i, Alias of `Variant[Pattern[/^(([a-zA-Z]:[\\\/])|([\\\/][\\\/][^\\\/]+[\\\/][^\\\/]+)|([\\\/][\\\/]\?[\\\/][^\\\/]+))/], Pattern[/^\//]]` ### `Stdlib::Compat::Array` Emulate the is_array and validate_array functions Alias of `Array[Any]` ### `Stdlib::Compat::Bool` Emulate the is_bool and validate_bool functions Alias of `Boolean` ### `Stdlib::Compat::Float` Emulate the is_float function The regex is what's currently used in is_float To keep your development moving forward, you can also add a deprecation warning using the Integer type: ```class example($value) { validate_float($value,) }``` would turn into ``` class example(Stdlib::Compat::Float $value) { validate_float($value, 10, 0) assert_type(Integer[0, 10], $value) |$expected, $actual| { warning("The 'value' parameter for the 'ntp' class has type ${actual}, but should be ${expected}.") } } ``` This allows you to find all places where a consumers of your code call it with unexpected values. Alias of `Variant[Float, Pattern[/^-?(?:(?:[1-9]\d*)|0)(?:\.\d+)(?:[eE]-?\d+)?$/]]` ### `Stdlib::Compat::Hash` Emulate the is_hash and validate_hash functions Alias of `Hash[Any, Any]` ### `Stdlib::Compat::Integer` Emulate the is_integer and validate_integer functions The regex is what's currently used in is_integer validate_numeric also allows range checking, which cannot be mapped to the string parsing inside the function. For full backwards compatibility, you will need to keep the validate_numeric call around to catch everything. To keep your development moving forward, you can also add a deprecation warning using the Integer type: ```class example($value) { validate_integer($value, 10, 0) }``` would turn into ``` class example(Stdlib::Compat::Integer $value) { validate_numeric($value, 10, 0) assert_type(Integer[0, 10], $value) |$expected, $actual| { warning("The 'value' parameter for the 'ntp' class has type ${actual}, but should be ${expected}.") } } ``` > Note that you need to use Variant[Integer[0, 10], Float[0, 10]] if you want to match both integers and floating point numbers. This allows you to find all places where a consumers of your code call it with unexpected values. Alias of `Variant[Integer, Pattern[/^-?(?:(?:[1-9]\d*)|0)$/], Array[Variant[Integer, Pattern[/^-?(?:(?:[1-9]\d*)|0)$/]]]]` ### `Stdlib::Compat::Ip_address` The Stdlib::Compat::Ip_address data type. Alias of `Variant[Stdlib::Compat::Ipv4, Stdlib::Compat::Ipv6]` ### `Stdlib::Compat::Ipv4` Emulate the validate_ipv4_address and is_ipv4_address functions Alias of `Pattern[/^((([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d))[.]){3}([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d)))(\/((([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d))[.]){3}([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d))|[0-9]+))?$/]` ### `Stdlib::Compat::Ipv6` The Stdlib::Compat::Ipv6 data type. Alias of `Pattern[/\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*$/]` ### `Stdlib::Compat::Numeric` Emulate the is_numeric and validate_numeric functions The regex is what's currently used in is_numeric validate_numeric also allows range checking, which cannot be mapped to the string parsing inside the function. For full backwards compatibility, you will need to keep the validate_numeric call around to catch everything. To keep your development moving forward, you can also add a deprecation warning using the Integer type: ```class example($value) { validate_numeric($value, 10, 0) }``` would turn into ``` class example(Stdlib::Compat::Numeric $value) { validate_numeric($value, 10, 0) assert_type(Integer[0, 10], $value) |$expected, $actual| { warning("The 'value' parameter for the 'ntp' class has type ${actual}, but should be ${expected}.") } } ``` > Note that you need to use Variant[Integer[0, 10], Float[0, 10]] if you want to match both integers and floating point numbers. This allows you to find all places where a consumers of your code call it with unexpected values. Alias of `Variant[Numeric, Pattern[/^-?(?:(?:[1-9]\d*)|0)(?:\.\d+)?(?:[eE]-?\d+)?$/], Array[Variant[Numeric, Pattern[/^-?(?:(?:[1-9]\d*)|0)(?:\.\d+)?(?:[eE]-?\d+)?$/]]]]` ### `Stdlib::Compat::String` Emulate the is_string and validate_string functions Alias of `Optional[String]` ### `Stdlib::Datasize` The Stdlib::Datasize data type. Alias of `Pattern[/^\d+(?i:[kmgt]b?|b)$/]` ### `Stdlib::Ensure::File` The Stdlib::Ensure::File data type. Alias of `Enum['present', 'file', 'directory', 'link', 'absent']` ### `Stdlib::Ensure::File::Directory` The Stdlib::Ensure::File::Directory data type. Alias of `Enum['directory', 'absent']` ### `Stdlib::Ensure::File::File` The Stdlib::Ensure::File::File data type. Alias of `Enum['file', 'absent']` ### `Stdlib::Ensure::File::Link` The Stdlib::Ensure::File::Link data type. Alias of `Enum['link', 'absent']` ### `Stdlib::Ensure::Service` The Stdlib::Ensure::Service data type. Alias of `Enum['stopped', 'running']` ### `Stdlib::Filemode` 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 `Variant[Stdlib::Absolutepath, Stdlib::HTTPUrl, Pattern[ /\Afile:\/\/\/([^\n\/\0]+(\/)?)+\z/, /\Apuppet:\/\/(([\w-]+\.?)+)?\/([^\n\/\0]+(\/)?)+\z/, ]]` ### `Stdlib::Fqdn` The Stdlib::Fqdn data type. Alias of `Pattern[/\A(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])\z/]` ### `Stdlib::HTTPSUrl` The Stdlib::HTTPSUrl data type. Alias of `Pattern[/(?i:\Ahttps:\/\/.*\z)/]` ### `Stdlib::HTTPUrl` The Stdlib::HTTPUrl data type. Alias of `Pattern[/(?i:\Ahttps?:\/\/.*\z)/]` ### `Stdlib::Host` The Stdlib::Host data type. Alias of `Variant[Stdlib::Fqdn, Stdlib::Compat::Ip_address]` ### `Stdlib::IP::Address` The Stdlib::IP::Address data type. Alias of `Variant[Stdlib::IP::Address::V4, Stdlib::IP::Address::V6]` ### `Stdlib::IP::Address::Nosubnet` The Stdlib::IP::Address::Nosubnet data type. Alias of `Variant[Stdlib::IP::Address::V4::Nosubnet, Stdlib::IP::Address::V6::Nosubnet]` ### `Stdlib::IP::Address::V4` The Stdlib::IP::Address::V4 data type. Alias of `Variant[Stdlib::IP::Address::V4::CIDR, Stdlib::IP::Address::V4::Nosubnet]` ### `Stdlib::IP::Address::V4::CIDR` 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` The Stdlib::IP::Address::V6 data type. Alias of `Variant[Stdlib::IP::Address::V6::Full, Stdlib::IP::Address::V6::Compressed, Stdlib::IP::Address::V6::Alternative, Stdlib::IP::Address::V6::Nosubnet]` ### `Stdlib::IP::Address::V6::Alternative` 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` The Stdlib::IP::Address::V6::Compressed data type. Alias of `Pattern[/\A:(:|(:[[:xdigit:]]{1,4}){1,7})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){1}(:|(:[[:xdigit:]]{1,4}){1,6})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){2}(:|(:[[:xdigit:]]{1,4}){1,5})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){3}(:|(:[[:xdigit:]]{1,4}){1,4})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){4}(:|(:[[:xdigit:]]{1,4}){1,3})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){5}(:|(:[[:xdigit:]]{1,4}){1,2})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){6}(:|(:[[:xdigit:]]{1,4}){1,1})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){7}:(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/]` ### `Stdlib::IP::Address::V6::Full` The Stdlib::IP::Address::V6::Full data type. Alias of `Pattern[/\A[[:xdigit:]]{1,4}(:[[:xdigit:]]{1,4}){7}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/]` ### `Stdlib::IP::Address::V6::Nosubnet` The Stdlib::IP::Address::V6::Nosubnet data type. Alias of `Variant[Stdlib::IP::Address::V6::Nosubnet::Full, Stdlib::IP::Address::V6::Nosubnet::Compressed, Stdlib::IP::Address::V6::Nosubnet::Alternative]` ### `Stdlib::IP::Address::V6::Nosubnet::Alternative` 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` The Stdlib::IP::Address::V6::Nosubnet::Compressed data type. Alias of `Pattern[/\A:(:|(:[[:xdigit:]]{1,4}){1,7})\z/, /\A([[:xdigit:]]{1,4}:){1}(:|(:[[:xdigit:]]{1,4}){1,6})\z/, /\A([[:xdigit:]]{1,4}:){2}(:|(:[[:xdigit:]]{1,4}){1,5})\z/, /\A([[:xdigit:]]{1,4}:){3}(:|(:[[:xdigit:]]{1,4}){1,4})\z/, /\A([[:xdigit:]]{1,4}:){4}(:|(:[[:xdigit:]]{1,4}){1,3})\z/, /\A([[:xdigit:]]{1,4}:){5}(:|(:[[:xdigit:]]{1,4}){1,2})\z/, /\A([[:xdigit:]]{1,4}:){6}(:|(:[[:xdigit:]]{1,4}){1,1})\z/, /\A([[:xdigit:]]{1,4}:){7}:\z/]` ### `Stdlib::IP::Address::V6::Nosubnet::Full` The Stdlib::IP::Address::V6::Nosubnet::Full data type. Alias of `Pattern[/\A[[:xdigit:]]{1,4}(:[[:xdigit:]]{1,4}){7}\z/]` ### `Stdlib::MAC` A type for a MAC address Alias of `Pattern[/\A([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})\z/, /\A([0-9A-Fa-f]{2}[:-]){19}([0-9A-Fa-f]{2})\z/]` ### `Stdlib::ObjectStore` The Stdlib::ObjectStore data type. Alias of `Variant[Stdlib::ObjectStore::GSUri, Stdlib::ObjectStore::S3Uri]` ### `Stdlib::ObjectStore::GSUri` The Stdlib::ObjectStore::GSUri data type. Alias of `Pattern[/\Ags:\/\/.*\z/]` ### `Stdlib::ObjectStore::S3Uri` The Stdlib::ObjectStore::S3Uri data type. Alias of `Pattern[/\As3:\/\/.*\z/]` ### `Stdlib::Port` The Stdlib::Port data type. Alias of `Integer[0, 65535]` ### `Stdlib::Port::Dynamic` The Stdlib::Port::Dynamic data type. Alias of `Integer[49152, 65535]` ### `Stdlib::Port::Ephemeral` The Stdlib::Port::Ephemeral data type. Alias of `Stdlib::Port::Dynamic` ### `Stdlib::Port::Privileged` The Stdlib::Port::Privileged data type. Alias of `Integer[1, 1023]` ### `Stdlib::Port::Registered` The Stdlib::Port::Registered data type. Alias of `Stdlib::Port::User` ### `Stdlib::Port::Unprivileged` The Stdlib::Port::Unprivileged data type. Alias of `Integer[1024, 65535]` ### `Stdlib::Port::User` The Stdlib::Port::User data type. Alias of `Integer[1024, 49151]` ### `Stdlib::Syslogfacility` The Stdlib::Syslogfacility data type. Alias of `Enum['kern', 'user', 'mail', 'daemon', 'auth', 'syslog', 'lpr', 'news', 'uucp', 'cron', 'authpriv', 'ftp', 'ntp', 'security', 'console', 'solaris-cron', 'local0', 'local1', 'local2', 'local3', 'local4', 'local5', 'local6', 'local7']` ### `Stdlib::Unixpath` this regex rejects any path component that does not start with "/" or is NUL Alias of `Pattern[/\A\/([^\n\/\0]+\/*)*\z/]` ### `Stdlib::Windowspath` The Stdlib::Windowspath data type. Alias of `Pattern[/\A(([a-zA-Z]:[\\\/])|([\\\/][\\\/][^\\\/]+[\\\/][^\\\/]+)|([\\\/][\\\/]\?[\\\/][^\\\/]+)).*\z/]` ### `Stdlib::Yes_no` The Stdlib::Yes_no data type. Alias of `Pattern[/\A(?i:(yes|no))\z/]` diff --git a/RELEASE_PROCESS.markdown b/RELEASE_PROCESS.markdown index 0f9328e..083eeeb 100644 --- a/RELEASE_PROCESS.markdown +++ b/RELEASE_PROCESS.markdown @@ -1,24 +1,24 @@ # Contributing to this module # * 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. * Update the CHANGELOG * Update the Modulefile * Commit these changes with a message along the lines of "Update CHANGELOG and Modulefile for release" * Create an annotated tag with git tag -a vX.Y.Z -m 'version X.Y.Z' (NOTE the leading v as per semver.org) * Push the tag with git push origin --tags * Build a new package with puppet-module or the rake build task if it exists * Publish the new package to the forge * Bonus points for an announcement to puppet-users. diff --git a/lib/facter/puppet_settings.rb b/lib/facter/puppet_settings.rb index 1ab3d8c..97deaad 100644 --- a/lib/facter/puppet_settings.rb +++ b/lib/facter/puppet_settings.rb @@ -1,44 +1,44 @@ # These facter facts return the value of the Puppet vardir and environment path # settings for the node running puppet or puppet agent. The intent is to # enable Puppet modules to automatically have insight into a place where they -# can place variable data, or for modules running on the puppet master to know +# can place variable data, or for modules running on the puppet server to know # where environments are stored. # # The values should be directly usable in a File resource path attribute. # 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/puppet/parser/functions/is_absolute_path.rb b/lib/puppet/parser/functions/is_absolute_path.rb index 9913dba..f309913 100644 --- a/lib/puppet/parser/functions/is_absolute_path.rb +++ b/lib/puppet/parser/functions/is_absolute_path.rb @@ -1,59 +1,59 @@ # # is_absolute_path.rb # module Puppet::Parser::Functions newfunction(:is_absolute_path, :type => :rvalue, :arity => 1, :doc => <<-'DOC') do |args| @summary **Deprecated:** Returns boolean true if the string represents an absolute path in the filesystem. This function works for windows and unix style paths. @example The following values will return true: $my_path = 'C:/Program Files (x86)/Puppet Labs/Puppet' is_absolute_path($my_path) $my_path2 = '/var/lib/puppet' is_absolute_path($my_path2) $my_path3 = ['C:/Program Files (x86)/Puppet Labs/Puppet'] is_absolute_path($my_path3) $my_path4 = ['/var/lib/puppet'] is_absolute_path($my_path4) @example The following values will return false: is_absolute_path(true) is_absolute_path('../var/lib/puppet') is_absolute_path('var/lib/puppet') $undefined = undef is_absolute_path($undefined) @return [Boolean] Returns `true` or `false` > **Note:* **Deprecated** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). DOC function_deprecation([:is_absolute_path, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Absolute_path. There is further documentation for validate_legacy function in the README.']) require 'puppet/util' path = args[0] # This logic was borrowed from - # [lib/puppet/file_serving/base.rb](https://github.com/puppetlabs/puppet/blob/master/lib/puppet/file_serving/base.rb) + # [lib/puppet/file_serving/base.rb](https://github.com/puppetlabs/puppet/blob/main/lib/puppet/file_serving/base.rb) # Puppet 2.7 and beyond will have Puppet::Util.absolute_path? Fall back to a back-ported implementation otherwise. if Puppet::Util.respond_to?(:absolute_path?) value = (Puppet::Util.absolute_path?(path, :posix) || Puppet::Util.absolute_path?(path, :windows)) else # This code back-ported from 2.7.x's lib/puppet/util.rb Puppet::Util.absolute_path? # Determine in a platform-specific way whether a path is absolute. This # defaults to the local platform if none is specified. # Escape once for the string literal, and once for the regex. slash = '[\\\\/]' name = '[^\\\\/]+' regexes = { :windows => %r{^(([A-Z]:#{slash})|(#{slash}#{slash}#{name}#{slash}#{name})|(#{slash}#{slash}\?#{slash}#{name}))}i, :posix => %r{^/}, } value = !!(path =~ regexes[:posix]) || !!(path =~ regexes[:windows]) # rubocop:disable Style/DoubleNegation : No alternative known end value end end diff --git a/lib/puppet/parser/functions/pry.rb b/lib/puppet/parser/functions/pry.rb index c6333cc..4191951 100644 --- a/lib/puppet/parser/functions/pry.rb +++ b/lib/puppet/parser/functions/pry.rb @@ -1,35 +1,35 @@ # # 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 master' + Puppet.warning 'pry(): cowardly refusing to start the debugger on a daemonized server' end end end diff --git a/lib/puppet/parser/functions/pw_hash.rb b/lib/puppet/parser/functions/pw_hash.rb index ee008dd..9b8e0d8 100644 --- a/lib/puppet/parser/functions/pw_hash.rb +++ b/lib/puppet/parser/functions/pw_hash.rb @@ -1,70 +1,70 @@ # 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 type of hash to use. It will be converted into the appropriate crypt(3) hash specifier. Valid hash types are: |Hash type |Specifier| |---------------------|---------| |MD5 |1 | |SHA-256 |5 | |SHA-512 (recommended)|6 | The third argument to this function is the salt to use. @return [Hash] Provides a hash usable on most POSIX systems. - > *Note:*: this uses the Puppet Master's implementation of crypt(3). If your + > *Note:*: this uses the Puppet Server's implementation of crypt(3). If your environment contains several different operating systems, ensure that they are compatible before using this function. DOC ) do |args| raise ArgumentError, "pw_hash(): wrong number of arguments (#{args.size} for 3)" if args.size != 3 args.map! do |arg| if (defined? Puppet::Pops::Types::PSensitiveType::Sensitive) && (arg.is_a? Puppet::Pops::Types::PSensitiveType::Sensitive) arg.unwrap else arg end end raise ArgumentError, 'pw_hash(): first argument must be a string' unless args[0].is_a?(String) || args[0].nil? raise ArgumentError, 'pw_hash(): second argument must be a string' unless args[1].is_a? String hashes = { 'md5' => '1', 'sha-256' => '5', 'sha-512' => '6' } hash_type = hashes[args[1].downcase] raise ArgumentError, "pw_hash(): #{args[1]} is not a valid hash type" if hash_type.nil? raise ArgumentError, 'pw_hash(): third argument must be a string' unless args[2].is_a? String raise ArgumentError, 'pw_hash(): third argument must not be empty' if args[2].empty? raise ArgumentError, 'pw_hash(): characters in salt must be in the set [a-zA-Z0-9./]' unless args[2] =~ %r{\A[a-zA-Z0-9./]+\z} password = args[0] return nil if password.nil? || password.empty? salt = "$#{hash_type}$#{args[2]}" # handle weak implementations of String#crypt if 'test'.crypt('$1$1') != '$1$1$Bp8CU9Oujr9SSEw53WV6G.' # JRuby < 1.7.17 # MS Windows and other systems that don't support enhanced salts raise Puppet::ParseError, 'system does not support enhanced salts' unless RUBY_PLATFORM == 'java' # puppetserver bundles Apache Commons Codec org.apache.commons.codec.digest.Crypt.crypt(password.to_java_bytes, salt) else password.crypt(salt) end end diff --git a/readmes/README_ja_JP.md b/readmes/README_ja_JP.md index 0e5c71f..21182f4 100644 --- a/readmes/README_ja_JP.md +++ b/readmes/README_ja_JP.md @@ -1,3135 +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 masterのホストネームです。 +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 masterを実行しているときにのみ使用する必要があります。PuppetのRubyGemsに`pry` gemがインストールされている必要があります。 +現在のスコープオブジェクトで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 masterのcrypt(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/master/metadata.json)を参照してください。 +サポートされているオペレーティングシステムの一覧については、[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)を参照してください。 このモジュールの一部に関するバグの報告または調査は、 [http://tickets.puppetlabs.com/browse/MODULES](http://tickets.puppetlabs.com/browse/MODULES)からお願いします。 ## コントリビュータ コントリビュータのリストは、[https://github.com/puppetlabs/puppetlabs-stdlib/graphs/contributors](https://github.com/puppetlabs/puppetlabs-stdlib/graphs/contributors)で見ることができます。