beaker-hiera 0.6.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb77aa5ce898f9f4722b09efa970d546e19c3e1c4f2d245ce50322cf01522e04
-  data.tar.gz: d065cefe4ee313132d5728ad657c2da68188ab0fab4c8e63298634c790de1684
+  metadata.gz: b27d17635f579df615e3fdf6aa4cb1ad23505caca158d34bb9c30b13b3b1f831
+  data.tar.gz: c18828b952f9489fa26b7edc266d2caae232f118854a424fd22fc8f7680e03a8
 SHA512:
-  metadata.gz: 463c83684e9f8e2482426874ef7afc35ae91a39086b5fb0a7e71761bd28e6a6c660f1ceeb7bc26f57ed315c1fef351b6ad42ee0b5f0dae893ec0d33142aca703
-  data.tar.gz: a47500a6d076eef1e25ad994d54de397e51a9525be12892d573fedc433519922b7ff7da31f7a5334b1d6dbf6da47863b0f69eb9ab0b23ea6f795dff186f29dbb
+  metadata.gz: 7d6b9812852ebd39d41970851225376dba1a6349ddf7ba60272836739ebcd32d77720bea1fe24302acf62cbbf533169fd35db05bff0b33852806020a99cf8303
+  data.tar.gz: a00341b48d51817fe42642046a86080e376b9a97e1ea25a786f00a3e92622c639e85c58e2768467b85622760f530c4d0bca41e2048a0aa3e4da656d8e7a1c65d

data/.github/workflows/release.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     if: github.repository_owner == 'voxpupuli'
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Install Ruby 3.0
         uses: ruby/setup-ruby@v1
         with:

data/.github/workflows/test.yml

@@ -13,7 +13,7 @@ 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:
@@ -36,7 +36,7 @@ jobs:
       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:

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [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 +32,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

@@ -2,12 +2,32 @@
 
 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')

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

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.0.0'.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.0.0
 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: 2023-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry