beaker-hiera 0.5.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6fa301c34061f47569899cb912a65ef2445800aa858aeb73bd409a2c458b9032
-  data.tar.gz: 3b9fe6eefd16dcee3a9ddfc40c157047b832e870728ef8c14996e37566102cd3
+  metadata.gz: b27d17635f579df615e3fdf6aa4cb1ad23505caca158d34bb9c30b13b3b1f831
+  data.tar.gz: c18828b952f9489fa26b7edc266d2caae232f118854a424fd22fc8f7680e03a8
 SHA512:
-  metadata.gz: 2cbb692a5db729f93a2564a46cdaa756cb703698ef864eec4e0e596101092b02b70def1b09b228894e30c6ed329c22220132249a80b59b21d1e6e57bc1f9c35e
-  data.tar.gz: dd46816d6f16cb699db0413d17d514494ef0c9cbfea3757f8af6dd69fb8ee86a17b9e29297a5d8ddd219911997e9e4c5d75c5bdf20fe5fce50ec1c85f69b5667
+  metadata.gz: 7d6b9812852ebd39d41970851225376dba1a6349ddf7ba60272836739ebcd32d77720bea1fe24302acf62cbbf533169fd35db05bff0b33852806020a99cf8303
+  data.tar.gz: a00341b48d51817fe42642046a86080e376b9a97e1ea25a786f00a3e92622c639e85c58e2768467b85622760f530c4d0bca41e2048a0aa3e4da656d8e7a1c65d

data/.github/workflows/release.yml

@@ -1,22 +1,32 @@
 name: Release
 
 on:
-  create:
-    ref_type: tag
+  push:
+    tags:
+      - '*'
 
 jobs:
   release:
     runs-on: ubuntu-latest
-    if: github.repository == 'voxpupuli/beaker-hiera'
+    if: github.repository_owner == 'voxpupuli'
     steps:
-      - uses: actions/checkout@v3
-      - name: Install Ruby 2.7
+      - uses: actions/checkout@v4
+      - name: Install Ruby 3.0
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: '2.7'
+          ruby-version: '3.0'
+        env:
+          BUNDLE_WITHOUT: release:development:rubocop
       - name: Build gem
         run: gem build *.gemspec
-      - name: Publish gem
+      - name: Publish gem to rubygems.org
         run: gem push *.gem
         env:
           GEM_HOST_API_KEY: '${{ secrets.RUBYGEMS_AUTH_TOKEN }}'
+      - name: Setup GitHub packages access
+        run: |
+          mkdir -p ~/.gem
+          echo ":github: Bearer ${{ secrets.GITHUB_TOKEN }}" >> ~/.gem/credentials
+          chmod 0600 ~/.gem/credentials
+      - name: Publish gem to GitHub packages
+        run: gem push --key github --host https://rubygems.pkg.github.com/voxpupuli *.gem

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/.rubocop.yml

@@ -1,5 +1,6 @@
 ---
 inherit_from: .rubocop_todo.yml
 
+
 inherit_gem:
-  beaker: rubocop.yml
+  voxpupuli-rubocop: rubocop.yml

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2023-03-27 16:34:12 UTC using RuboCop version 1.48.1.
+# on 2023-05-05 10:34:45 UTC using RuboCop version 1.50.2.
 # 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

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # 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)
+
+**Merged pull requests:**
+
+- GCG: Add faraday-retry dep [\#26](https://github.com/voxpupuli/beaker-hiera/pull/26) ([bastelfreak](https://github.com/bastelfreak))
+- switch to voxpupuli-rubocop and cleanup gemspec [\#25](https://github.com/voxpupuli/beaker-hiera/pull/25) ([bastelfreak](https://github.com/bastelfreak))
+- Update release workflow for Vox Pupuli standard [\#24](https://github.com/voxpupuli/beaker-hiera/pull/24) ([bastelfreak](https://github.com/bastelfreak))
+
 ## [0.5.0](https://github.com/voxpupuli/beaker-hiera/tree/0.5.0) (2023-03-28)
 
 [Full Changelog](https://github.com/voxpupuli/beaker-hiera/compare/0.4.0...0.5.0)
@@ -14,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/Gemfile

@@ -3,5 +3,6 @@ source ENV['GEM_SOURCE'] || 'https://rubygems.org'
 gemspec
 
 group :release do
+  gem 'faraday-retry', require: false
   gem 'github_changelog_generator', require: false
 end

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/beaker-hiera.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.homepage    = 'https://github.com/voxpupuli/beaker-hiera'
   s.summary     = 'Hiera DSL Helpers!'
   s.description = 'For use for the Beaker acceptance testing tool'
-  s.license     = 'Apache2'
+  s.license     = 'Apache-2.0'
 
   s.files         = `git ls-files`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
@@ -21,16 +21,8 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'pry', '~> 0.10'
   s.add_development_dependency 'rake', '~> 13.0'
   s.add_development_dependency 'rspec', '~> 3.0'
-  s.add_development_dependency 'rubocop', '~> 1.48.1'
-  s.add_development_dependency 'rubocop-performance', '~> 1.10'
-  s.add_development_dependency 'rubocop-rake', '~> 0.2'
-  s.add_development_dependency 'rubocop-rspec', '>= 1.44'
-  s.add_development_dependency 'simplecov'
-
-  # Documentation dependencies
-  s.add_development_dependency 'markdown'
-  s.add_development_dependency 'thin'
-  s.add_development_dependency 'yard'
+  s.add_development_dependency 'simplecov', '~> 0.22.0'
+  s.add_development_dependency 'voxpupuli-rubocop', '~> 1.2'
 
   # Run time dependencies
   s.add_runtime_dependency 'beaker', '>= 4', '< 6'

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.5.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.5.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Vox Pupuli
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-28 00:00:00.000000000 Z
+date: 2023-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -54,117 +54,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.48.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.48.1
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: 0.22.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: 0.22.0
 - !ruby/object:Gem::Dependency
-  name: rubocop-rake
+  name: voxpupuli-rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.44'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.44'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: markdown
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: thin
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: beaker
   requirement: !ruby/object:Gem::Requirement
@@ -215,7 +131,7 @@ files:
 - spec/spec_helper.rb
 homepage: https://github.com/voxpupuli/beaker-hiera
 licenses:
-- Apache2
+- Apache-2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -235,7 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.33
 signing_key: 
 specification_version: 4
 summary: Hiera DSL Helpers!