msmg-hiera-templater 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 93f1bedbdcc88d9f3ae602533735b89d35c99b52525536a63b83bc982278541b
+  data.tar.gz: d078a5d8fd9adc3c32c2380320cf504fc1f9547524689b2a5624bbfc0eb0d6c4
+SHA512:
+  metadata.gz: 1d91190aba1abd9d9946d41899e3a0e63a87135ab6f2d388b214e676a0f646fa2d2c2cbd042d2d145a11483b4d941f712c421b3971d6ac895df7b71f87fe26cb
+  data.tar.gz: 215c48e206f3ebc32701e12e622f46ae9ab4eb7d4b9b3c9f31db95071ab212ae4ef9b63960270c7ae74dc427dc6ddff3cd36a94f79425817ac1833ae95a8ecfc

data/bin/hiera-templater

@@ -0,0 +1,67 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'optparse'
+require_relative '../lib/hiera_template'
+
+args = { config: HieraTemplate::DEFAULT_CONFIG }
+opt_parser = OptionParser.new do |opts|
+  opts.banner = <<~USAGE
+    Usage: #{File.basename(__FILE__)} [options] <file/folder>
+
+    Processes a specific .erb template or a folder hierarchy for .erb files.
+    Note that only files named with an .erb suffix will be processed and the output file will match the
+    name but with the suffix removed.
+
+    The erb files in the folder must use hiera('key') to retrieve a data item.
+  USAGE
+
+  opts.on('-c CONFIG_FILE', '--config=CONFIG_FILE', String,
+          "hiera configuration file (default #{args[:config]})") do |c|
+    args[:config] = c
+  end
+
+  opts.on('-r', '--recurse', TrueClass, 'Recurse a specified folder rather than specify a file name') do |n|
+    args[:recurse] = n
+  end
+
+  opts.on('-f', '--force', TrueClass, 'Force overwrite if output file exists') do |f|
+    args[:overwrite] = f
+  end
+
+  opts.on('-h', '--help', 'Prints this help') do
+    puts opts
+    exit
+  end
+end
+opt_parser.parse!
+name = ARGV.shift
+unless name && ((File.directory?(name) && args[:recurse]) || (File.exist?(name) && File.extname(name) == '.erb'))
+  puts opt_parser.help
+  exit 1
+end
+templater = HieraTemplate.new(args[:config])
+
+def strip_suffix(file, args)
+  new_file = File.join(File.dirname(file), File.basename(file, '.erb'))
+  return new_file if args[:overwrite] || !File.exist?(new_file)
+
+  abort "#{new_file} already exists (based on template #{file})"
+end
+
+def process_file(templater, file, args)
+  content = File.read(file)
+  output = templater.render(content)
+  return unless output.is_a?(String) # Detect custom output
+
+  out_file = strip_suffix(file, args)
+  File.write(out_file, output)
+end
+
+if args[:recurse]
+  Dir.glob(File.join(name, '**', '*.erb')) do |file|
+    process_file(templater, file, args)
+  end
+else
+  process_file(templater, name, args)
+end

data/lib/erb_reflective.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'erb'
+
+# Override some ERB behaviour to make it reflect methods supported
+# by an object that is passed to it
+class ERBReflective < ERB
+  # Simply store the object reference passed in
+  # then call the superclass behaviour with our binding instead
+  def result(other_object)
+    @other_object = other_object
+    super(binding)
+  end
+
+  def method_missing(meth, *args, &block)
+    super unless respond_to_missing? meth
+    @other_object&.send(meth, *args, &block)
+  end
+
+  def respond_to_missing?(meth)
+    @other_object&.respond_to? meth
+  end
+end

data/lib/hiera_template.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'facter'
+require 'hiera'
+
+require_relative 'erb_reflective'
+
+# Templating handler object used by ERBReflective
+class HieraTemplate
+  DEFAULT_CONFIG = '/etc/puppet/hiera.yaml'
+
+  def initialize(hiera_config = DEFAULT_CONFIG)
+    @scope = Facter.to_hash # Time consuming, do it once if possible!
+    # Just so we can handle old facter references starting ::
+    legacy = @scope.map { |k, v| ["::#{k}", v] }
+    @scope.merge!(Hash[legacy])
+    @hiera = Hiera.new(config: hiera_config)
+  end
+
+  # Template render
+  def render(content)
+    @blocks = []
+    rendered = ERBReflective.new(content, nil, '-').result(self)
+    return rendered unless @blocks.any?
+
+    # See custom_out
+    @blocks.each { |block| block.call(rendered) }
+    true
+  end
+
+  # Methods used by ERBReflective to access hiera data
+  # See above, full content is not available until the template is rendered so
+  # we only stash the block references that we are given and call it later
+  def custom_out(&block)
+    raise StandardError, 'custom_out requires a block argument' unless block_given?
+
+    @blocks << block
+  end
+
+  # The DSL
+
+  # If hiera does not exist we will try facter data in scope to unify the API
+  def hiera(key, default = nil)
+    @hiera.lookup(key, nil, @scope) || @scope.dig(*key.split('.')) || default
+  end
+
+  def hiera_hash(key, default = nil)
+    @hiera.lookup(key, default, @scope, nil, :hash)
+  end
+
+  def hiera_array(key, default = nil)
+    @hiera.lookup(key, default, @scope, nil, :array)
+  end
+
+  def mkdir_p(path, owner: nil, group: nil, mode: nil)
+    custom_out do |_|
+      FileUtils.mkdir_p(path)
+      FileUtils.chown_R(owner, group, path) if owner || group
+      FileUtils.chmod_R(mode, path) if mode
+    end
+  end
+
+  def custom_file(path, owner: nil, group: nil, mode: nil)
+    custom_out do |content|
+      File.write(path, content)
+      FileUtils.chown(owner, group, path) if owner || group
+      FileUtils.chmod(mode, path) if mode
+    end
+  end
+end

data/msmg-hiera-templater.gemspec

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |s|
+  s.name = 'msmg-hiera-templater'
+  s.version = '0.0.1'
+  s.authors = ['Andrew Smith']
+  s.email = ['andrew.smith at moneysupermarket.com']
+  s.required_ruby_version = '>=2.5'
+  s.summary = 'Render ERB templates from heira without requiring puppet'
+  s.description = 'MSM pubicly available Ruby'
+  s.homepage = 'https://github.com/MSMFG/msmg-hiera-templater'
+  s.license = 'Apache-2.0'
+  s.files = `git ls-files -z`.split("\x0")
+  s.add_runtime_dependency 'facter', ['~>4.2']
+  s.add_runtime_dependency 'hiera', ['~>3.7']
+  s.bindir = 'bin'
+  s.executables << 'hiera-templater'
+end

data/readme.md

@@ -0,0 +1,111 @@
+# Hiera templater without puppet
+
+Requires facter and hiera gems, compatible with latest gems and versions installed on MSM instances.
+
+## Background
+
+The idea behind this prohect is to allow the power of hiera to be extended to folks that wish to use it
+in scenarios where they don't want to use puppet.
+
+## Operation - basics
+
+The CLI has only one required option, a file or a path to be parsed, path parsing must be enabled by passing the -r (recursive flag) and
+the CLI will then look for any file suffixed in .erb.
+
+In basic mode of operation the templater has a safeguard blocking the overwrite of existing files (possibly from previous runs) unless the
+-f flag (force) is also provided.
+
+Syntax as per help
+
+```
+andrew.smith@C02Z2A0SLVCG hiera-templater % ruby hiera_templater.rb 
+Usage: hiera_templater.rb [options] <file/folder>
+
+Processes a specific .erb template or a folder hierarchy for .erb files.
+Note that only files named with an .erb suffix will be processed and the output file will match the
+name but with the suffix removed.
+
+The erb files in the folder must use hiera('key') to retrieve a data item.
+    -c, --config=CONFIG_FILE         hiera configuration file (default /etc/puppet/hiera.yaml)
+    -r, --recurse                    Recurse a specified folder rather than specify a file name
+    -f, --force                      Force overwrite if output file exists
+    -h, --help                       Prints this help
+andrew.smith@C02Z2A0SLVCG hiera-templater % 
+```
+
+NOTE: In all modes of operation please attempt to utilise the recurse feature to process all your files, do NOT wrap this in another script as you will pay a 0.6 second penalty for each time the Facter library is initialised!!
+
+In basic operation the files are delivered to the same folder as the erb template with the erb suffix removed. All template files must have the trailing .erb suffix.
+
+ERB templates are processed with one of 3 hiera DSL lookup functions, these are..
+
+### hiera(<hey>, \[default\])
+
+A key, regardless of type is retrieved, this form will return any type including hash and array and can be given an optional default value for
+values that cannot be found.
+
+The hiera function ALSO includes a lookup for facter keys if not found in hiera, neither of the two other lookup functions do this.
+
+### hiera_array(<key>, \[default\])
+
+Type checked version of the above that will fail if a non array type is found.
+
+### hiera_hash(<key>, \[default\])
+
+Type checked version of the above that will fail if a non hash type is found.
+
+## Operation - More DSL usage
+
+If one wishes to output files to a specific folder rather than have then land automatically as placed by the script one can use one of 2 high level DSL
+functions.
+
+Noting that as soon as either of these or the more advanced custom_out function is used one is entirely responsible for the output to file, the tool will
+no longer automatically do that for you in these cases.
+
+### mkdir_p(\<path\>, \[owner: \<owner\>\], \[group: \<group\>\], \[mode: \<mode\>\]))
+
+This DSL function calls custom_out and is a helper to create a folder structure recursively with optional ownership and mode specifications.
+
+### custom_file(\<path\>, \[owner: \<owner\>\], \[group: \<group\>\], \[mode: \<mode\>\])
+
+This DSL function calls custom_out with a preset block to ensure the output file is written with the path and optionally ownership and mode specified.
+
+Note that custom_out blocks are performed in the order specified but following rendering so please ensure that any dependent file strictures are made (mkdir_p) before custome_file is used if it is dependent upon that path.
+
+## Operation - Advanced usage
+
+The templater implements custom_out as a function which takes a block of Ruby code as a parameter, this block should implement a parameter which will receive the rendered content (whether it uses it or not) and is free to utilise that content for more advanced purposes.
+
+## DSL Example
+```
+[root@ip-10-96-3-54 ~]# cat testing/dsl.erb 
+[Facter only]
+My IP is: <%= hiera('ipaddress_primary') %>
+
+[Something missing]
+  Non existant: <%= hiera('clearly::not_existing', 'but has default') %>
+
+<% mkdir_p('/tmp/test')
+   mkdir_p('/tmp/test2', owner: 'sysadmin', mode: 0500)
+   mkdir_p('/tmp/test3', group: 'sysadmin', mode: 0550)
+   mkdir_p('/tmp/test4', owner: 'root', group: 'sysadmin', mode: 0750)
+   custom_file('/tmp/test4/testfile', owner: 'root', group: 'sysadmin', mode: 0640) -%>
+```
+
+## Advanced example
+```
+[root@ip-10-96-3-54 ~]# cat testing/custom_out.erb 
+[Facter only]
+My IP is: <%= hiera('ipaddress_primary') %>
+
+[Something missing]
+  Non existant: <%= hiera('clearly::not_existing', 'but has default') %>
+
+<% custom_out do |content|
+    File.write('/tmp/footest', content) 
+    FileUtils.chmod(0640, '/tmp/footest')
+    FileUtils.chown('root', 'sysadmin', '/tmp/footest')
+  end -%>
+<% custom_out { |content| puts content } -%>
+[root@ip-10-96-3-54 ~]# 
+```

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: msmg-hiera-templater
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrew Smith
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: facter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: hiera
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+description: MSM pubicly available Ruby
+email:
+- andrew.smith at moneysupermarket.com
+executables:
+- hiera-templater
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/hiera-templater
+- lib/erb_reflective.rb
+- lib/hiera_template.rb
+- msmg-hiera-templater.gemspec
+- readme.md
+homepage: https://github.com/MSMFG/msmg-hiera-templater
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Render ERB templates from heira without requiring puppet
+test_files: []