beaker-hiera 0.6.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb77aa5ce898f9f4722b09efa970d546e19c3e1c4f2d245ce50322cf01522e04
-  data.tar.gz: d065cefe4ee313132d5728ad657c2da68188ab0fab4c8e63298634c790de1684
+  metadata.gz: '09b212e362fa594e532f6492163977dc3535be4aef9bd8fafeda5f0bff798ac1'
+  data.tar.gz: 9cb843cc2055ebc4c213cc5ac51c99669ae10d7bfec1835db916cc45c0a55379
 SHA512:
-  metadata.gz: 463c83684e9f8e2482426874ef7afc35ae91a39086b5fb0a7e71761bd28e6a6c660f1ceeb7bc26f57ed315c1fef351b6ad42ee0b5f0dae893ec0d33142aca703
-  data.tar.gz: a47500a6d076eef1e25ad994d54de397e51a9525be12892d573fedc433519922b7ff7da31f7a5334b1d6dbf6da47863b0f69eb9ab0b23ea6f795dff186f29dbb
+  metadata.gz: b50166b1991e2a83795d36a790737cd09f7dd9e1ee8544842bf55970cad54b59df4ff7cbc7cb56265013dc23f73570b1ab128542f7b418e4adf5c56f6ffa36a4
+  data.tar.gz: 3e47767c8da360497cd526be181855582f92e97d383dff5d6e10641dcee4717b38661f9e26b8bf618a74d08e7c8c82d27b4e86412872fa334275811a225a44c5

data/.github/workflows/release.yml

@@ -10,15 +10,15 @@ jobs:
     runs-on: ubuntu-latest
     if: github.repository_owner == 'voxpupuli'
     steps:
-      - uses: actions/checkout@v3
-      - name: Install Ruby 3.0
+      - uses: actions/checkout@v4
+      - name: Install Ruby 3.3
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: '3.0'
+          ruby-version: '3.3'
         env:
           BUNDLE_WITHOUT: release:development:rubocop
       - name: Build gem
-        run: gem build *.gemspec
+        run: gem build --strict --verbose *.gemspec
       - name: Publish gem to rubygems.org
         run: gem push *.gem
         env:

data/.github/workflows/test.yml

@@ -13,11 +13,11 @@ jobs:
   rubocop:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Install Ruby ${{ matrix.ruby }}
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: "2.7"
+          ruby-version: "3.3"
           bundler-cache: true
       - name: Run Rubocop
         run: bundle exec rake rubocop
@@ -32,11 +32,12 @@ jobs:
           - ruby: "3.0"
           - ruby: "3.1"
           - ruby: "3.2"
+          - ruby: "3.3"
     env:
       COVERAGE: ${{ matrix.coverage }}
     name: RSpec - Ruby ${{ matrix.ruby }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Install Ruby ${{ matrix.ruby }}
         uses: ruby/setup-ruby@v1
         with:
@@ -45,7 +46,7 @@ jobs:
       - name: spec tests
         run: bundle exec rake test
       - name: Build gem
-        run: gem build *.gemspec
+        run: gem build --strict --verbose *.gemspec
 
   tests:
     needs:

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2023-05-05 10:34:45 UTC using RuboCop version 1.50.2.
+# on 2024-05-28 09:37:31 UTC using RuboCop version 1.63.5.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -12,6 +12,7 @@
 # AllowedAcronyms: CLI, DSL, ACL, API, ASCII, CPU, CSS, DNS, EOF, GUID, HTML, HTTP, HTTPS, ID, IP, JSON, LHS, QPS, RAM, RHS, RPC, SLA, SMTP, SQL, SSH, TCP, TLS, TTL, UDP, UI, UID, UUID, URI, URL, UTF8, VM, XML, XMPP, XSRF, XSS
 Naming/FileName:
   Exclude:
+    - 'Rakefile.rb'
     - 'lib/beaker-hiera.rb'
 
 # Offense count: 1
@@ -38,6 +39,14 @@ RSpec/NamedSubject:
   Exclude:
     - 'spec/beaker-hiera/helpers_spec.rb'
 
+# Offense count: 1
+# Configuration parameters: Include, CustomTransform, IgnoreMethods, IgnoreMetadata.
+# Include: **/*_spec.rb
+RSpec/SpecFilePathFormat:
+  Exclude:
+    - '**/spec/routing/**/*'
+    - 'spec/beaker-hiera/helpers_spec.rb'
+
 # Offense count: 2
 RSpec/StubbedMock:
   Exclude:

data/CHANGELOG.md

@@ -1,5 +1,38 @@
 # Changelog
 
+## [1.1.1](https://github.com/voxpupuli/beaker-hiera/tree/1.1.1) (2024-05-28)
+
+[Full Changelog](https://github.com/voxpupuli/beaker-hiera/compare/1.1.0...1.1.1)
+
+There were some problems with the CI pipeline, so the 1.1.0 release was only published to GitHub packages, not to rubygems.org. This is fixed with the 1.1.1 release.
+
+**Fixed bugs:**
+
+- Fix typo in CI config [\#36](https://github.com/voxpupuli/beaker-hiera/pull/36) ([bastelfreak](https://github.com/bastelfreak))
+
+## [1.1.0](https://github.com/voxpupuli/beaker-hiera/tree/1.1.0) (2024-05-28)
+
+[Full Changelog](https://github.com/voxpupuli/beaker-hiera/compare/1.0.0...1.1.0)
+
+**Implemented enhancements:**
+
+- beaker: Allow 6.x [\#34](https://github.com/voxpupuli/beaker-hiera/pull/34) ([bastelfreak](https://github.com/bastelfreak))
+- Add Ruby 3.3 to CI matrix [\#33](https://github.com/voxpupuli/beaker-hiera/pull/33) ([bastelfreak](https://github.com/bastelfreak))
+
+**Merged pull requests:**
+
+- voxpupuli-rubocop: Require 2.7.0 [\#32](https://github.com/voxpupuli/beaker-hiera/pull/32) ([bastelfreak](https://github.com/bastelfreak))
+- CI: Build gems with strict and verbose mode [\#31](https://github.com/voxpupuli/beaker-hiera/pull/31) ([bastelfreak](https://github.com/bastelfreak))
+- README.md: Add badges, transfer notice and release information [\#30](https://github.com/voxpupuli/beaker-hiera/pull/30) ([bastelfreak](https://github.com/bastelfreak))
+
+## [1.0.0](https://github.com/voxpupuli/beaker-hiera/tree/1.0.0) (2023-11-03)
+
+[Full Changelog](https://github.com/voxpupuli/beaker-hiera/compare/0.6.0...1.0.0)
+
+**Breaking changes:**
+
+- Convert to Hiera 5 [\#17](https://github.com/voxpupuli/beaker-hiera/pull/17) ([ekohl](https://github.com/ekohl))
+
 ## [0.6.0](https://github.com/voxpupuli/beaker-hiera/tree/0.6.0) (2023-05-05)
 
 [Full Changelog](https://github.com/voxpupuli/beaker-hiera/compare/0.5.0...0.6.0)
@@ -24,7 +57,6 @@
 
 **Merged pull requests:**
 
-- Bump actions/checkout from 2 to 3 [\#23](https://github.com/voxpupuli/beaker-hiera/pull/23) ([dependabot[bot]](https://github.com/apps/dependabot))
 - Implement rubocop & fix violations [\#22](https://github.com/voxpupuli/beaker-hiera/pull/22) ([bastelfreak](https://github.com/bastelfreak))
 - dependabot: check for github actions and gems [\#21](https://github.com/voxpupuli/beaker-hiera/pull/21) ([bastelfreak](https://github.com/bastelfreak))
 

data/README.md

@@ -1,14 +1,63 @@
 # beaker-hiera
 
+[![License](https://img.shields.io/github/license/voxpupuli/beaker-hiera.svg)](https://github.com/voxpupuli/beaker-hiera/blob/master/LICENSE)
+[![codecov](https://codecov.io/gh/voxpupuli/beaker-hiera/branch/master/graph/badge.svg?token=Mypkl78hvK)](https://codecov.io/gh/voxpupuli/beaker-hiera)
+[![Release](https://github.com/voxpupuli/beaker-hiera/actions/workflows/release.yml/badge.svg)](https://github.com/voxpupuli/beaker-hiera/actions/workflows/release.yml)
+[![RubyGem Version](https://img.shields.io/gem/v/beaker-hiera.svg)](https://rubygems.org/gems/beaker-hiera)
+[![RubyGem Downloads](https://img.shields.io/gem/dt/beaker-hiera.svg)](https://rubygems.org/gems/beaker-hiera)
+[![Donated by Puppet Inc](https://img.shields.io/badge/donated%20by-Puppet%20Inc-fb7047.svg)](#transfer-notice)
+
 Beaker Hiera DSL Extension Library! This allows to easily use Hiera data in acceptance tests.
 
+## Usage
+
+The `write_hiera_config_on` method is the most important one.
+It writes the `hiera.yaml` file to the specified host or hosts.
+The version is always set to 5, as well as a default `datadir`.
+The `hierarchy` is directly what the [documentation](https://www.puppet.com/docs/puppet/7/hiera_config_yaml_5.html) specifies.
+It is then important to also copy the data from a local directory to the same host or hosts.
+
 ```ruby
 hierarchy = [
-  'fqdn/%{fqdn}.yaml',
-  'os/%{os.family}/%{os.release.major}.yaml',
-  'os/%{os.family}.yaml',
-  'common.yaml',
+  {
+    'name' => 'Per-node data',
+    'path' => 'fqdn/%{facts.networking.fqdn}.yaml',
+  },
+  {
+    'name' => 'OS family version data',
+    'path' => 'family/%{facts.os.family}/%{facts.os.release.major}.yaml',
+  },
+  {
+    'name' => 'OS family data',
+    'path' => 'family/%{facts.os.family}.yaml',
+  },
+  {
+    'name' => 'Common data',
+    'path' => 'common.yaml',
+  },
 ]
 write_hiera_config_on(host, hierarchy)
 copy_hiera_data_to(host, 'spec/acceptance/hieradata')
 ```
+
+## Transfer Notice
+
+This plugin was originally authored by [Puppet Inc](http://puppet.com).
+The maintainer preferred that Puppet Community take ownership of the module for future improvement and maintenance.
+Existing pull requests and issues were transferred over, please fork and continue to contribute here.
+
+Previously: https://github.com/puppetlabs/beaker-hiera
+
+## License
+
+This gem is licensed under the Apache-2 license.
+
+## Release information
+
+To make a new release, please do:
+* update the version in `lib/beaker-hiera/version.rb`
+* Install gems with `bundle install --with release --path .vendor`
+* generate the changelog with `bundle exec rake changelog`
+* Check if the new version matches the closed issues/PRs in the changelog
+* Create a PR with it
+* After it got merged, push a tag. GitHub actions will do the actual release to rubygems and GitHub Packages

data/Rakefile

@@ -22,7 +22,7 @@ rescue LoadError
   # github_changelog_generator is an optional release
 else
   GitHubChangelogGenerator::RakeTask.new :changelog do |config|
-    config.exclude_labels = %w[duplicate question invalid wontfix wont-fix skip-changelog]
+    config.exclude_labels = %w[duplicate question invalid wontfix wont-fix skip-changelog github_actions]
     config.user = 'voxpupuli'
     config.project = 'beaker-hiera'
     gem_version = Gem::Specification.load("#{config.project}.gemspec").version
@@ -31,14 +31,7 @@ else
 end
 
 begin
-  require 'rubocop/rake_task'
+  require 'voxpupuli/rubocop/rake'
 rescue LoadError
-  # RuboCop is an optional group
-else
-  RuboCop::RakeTask.new(:rubocop) do |task|
-    # These make the rubocop experience maybe slightly less terrible
-    task.options = ['--display-cop-names', '--display-style-guide', '--extra-details']
-    # Use Rubocop's Github Actions formatter if possible
-    task.formatters << 'github' if ENV['GITHUB_ACTIONS']
-  end
+  # the voxpupuli-rubocop gem is optional
 end

data/beaker-hiera.gemspec

@@ -22,8 +22,8 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rake', '~> 13.0'
   s.add_development_dependency 'rspec', '~> 3.0'
   s.add_development_dependency 'simplecov', '~> 0.22.0'
-  s.add_development_dependency 'voxpupuli-rubocop', '~> 1.2'
+  s.add_development_dependency 'voxpupuli-rubocop', '~> 2.7.0'
 
   # Run time dependencies
-  s.add_runtime_dependency 'beaker', '>= 4', '< 6'
+  s.add_runtime_dependency 'beaker', '>= 4', '< 7'
 end

data/lib/beaker-hiera/helpers.rb

@@ -9,17 +9,19 @@ module Beaker
         # @param [Host, Array<Host>, String, Symbol] host
         #   One or more hosts to act upon, or a role (String or Symbol) that
         #   identifies one or more hosts.
-        # @param [Array] hierarchy
-        #   One or more hierarchy paths
+        # @param [Array[Hash[String, String]]] hierarchy
+        #   The hierachy as specified in Hiera config YAML version 5
+        #
+        # @see https://www.puppet.com/docs/puppet/7/hiera_config_yaml_5.html
         def write_hiera_config_on(host, hierarchy)
           block_on host do |hst|
             hiera_config = {
-              backends: 'yaml',
-              yaml: {
-                datadir: hiera_datadir(hst),
+              'version' => 5,
+              'defaults' => {
+                'datadir' => hiera_datadir(hst),
+                'data_hash' => 'yaml_data',
               },
-              hierarchy: hierarchy,
-              logger: 'console',
+              'hierarchy' => hierarchy,
             }
             create_remote_file hst, hst.puppet['hiera_config'], hiera_config.to_yaml
           end

data/lib/beaker-hiera/version.rb

@@ -4,7 +4,7 @@ module Beaker
       module Hiera
         module Version
           # Current version of beaker-hiera
-          STRING = '0.6.0'.freeze
+          STRING = '1.1.1'.freeze
         end
       end
     end

data/spec/beaker-hiera/helpers_spec.rb

@@ -19,7 +19,7 @@ describe ClassMixedWithDSLHelpers do
   end
 
   describe '#write_hiera_config_on' do
-    let(:hierarchy) { ['nodes/%{::fqdn}', 'common'] }
+    let(:hierarchy) { [{ 'name' => 'common', 'path' => 'common.yaml' }] }
 
     it 'on host' do
       expect(subject).to receive(:create_remote_file).with(host, '/usr/face', %r{datadir: "/usr/code/hieradata"})
@@ -28,7 +28,7 @@ describe ClassMixedWithDSLHelpers do
   end
 
   describe '#write_hiera_config' do
-    let(:hierarchy) { ['nodes/%{::fqdn}', 'common'] }
+    let(:hierarchy) { [{ 'name' => 'common', 'path' => 'common.yaml' }] }
 
     it 'delegates to #write_hiera_config_on with the default host' do
       expect(subject).to receive(:default).and_return(host)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: beaker-hiera
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Vox Pupuli
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-05 00:00:00.000000000 Z
+date: 2024-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -73,14 +73,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 2.7.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 2.7.0
 - !ruby/object:Gem::Dependency
   name: beaker
   requirement: !ruby/object:Gem::Requirement
@@ -90,7 +90,7 @@ dependencies:
         version: '4'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -100,7 +100,7 @@ dependencies:
         version: '4'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7'
 description: For use for the Beaker acceptance testing tool
 email:
 - voxpupuli@groups.io
@@ -151,7 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.5.9
 signing_key: 
 specification_version: 4
 summary: Hiera DSL Helpers!