hiera-fs 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+--- 
+SHA1: 
+  metadata.gz: 6d846eab0030cfdd9864f3b9e7f188389fe6bbe9
+  data.tar.gz: 560777fe3604096865d9933d8d19bb187f3d0227
+SHA512: 
+  metadata.gz: bfbff9c16d2771f614abcae9b1ba8085502fe68124620fb57934a3a785a01befc41b611084bd66c22058526aaa4717028c5e573f05cda519a8597d484d6a5e35
+  data.tar.gz: d235a3108d137f8a22248bf10672bb1d8835600adb832182d0099fb0e9abda4af95a8d0ed9951b962b5739623d638f8cb1b5ab79d1ea683fc923e737bee4ee83

data/.gitignore

@@ -0,0 +1,2 @@
+pkg/
+*.gem$

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in teste.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Alan Castro
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,114 @@
+## hiera-fs: a file-system hiera backend
+
+### Instalation
+
+sudo gem install hiera-fs
+
+### Description
+
+Hiera-fs allows you create a more extensible module, by letting the user create
+specific files/templates somewhere in his hiera hierarchy.
+
+### Functions
+
+- `hiera_file(<key>, [<override>])`
+
+Returns a file's content from hiera hierarchy.
+The default files is `{modulename}/files/key`.
+
+- `hiera_template(<key>, [<override>])`
+
+Returns a templates's content from hiera hierarchy.
+The default template is `{modulename}/templates/key`.
+
+- `hiera_dir(<key>, [<override>])`
+
+Returns a hash of all files names and paths that exists in `key` directory in our hiera hierarchy.
+If directory does not exists, the function returns an empty hash `{}`.
+
+### How does it work?
+
+#### hiera\_template and hiera\_file
+
+For better understading, let's look at an example.
+
+Imagine we have the following dns module:
+
+    ├── dns
+    │   ├── files
+    │   │   └── resolv.conf
+    │   ├── manifests
+    │   │   └── init.pp
+    │   └── templates
+    │       └── resolv.conf.erb
+
+In our `manifests/init.pp` we have the following code:
+
+    class dns {
+      file { '/etc/resolv.conf.template':
+        ensure  => file,
+        content => hiera_template('resolv.conf.erb'),
+      }
+      file { '/etc/resolv.conf.file':
+        ensure  => file,
+        content => hiera_file('resolv.conf'),
+      }
+    }
+
+Our `templates/resolv.conf.erb` has the following code:
+
+    resolv.conf template
+    My operatingsystem <%= @operatingsystem %>
+
+Our `files/resolv.conf.erb` has the following code:
+
+    my resolv.conf file
+    <%= @operatingsystem %> will not work :/
+
+If you don't create any hiera configuration, your dns module will use the files
+defined in templates (for hiera\_template) and in files (for hiera\_file).
+
+Let's say that you have the following `hiera.yaml`
+
+    ---
+    :backends:
+      - fs
+    :fs:
+      :datadir: /etc/puppet/hiera
+    :hierarchy:
+      - common/%{calling_module}
+      - common
+
+The `hiera_template` call will look for your template in the following directories and order:
+
+    - /etc/puppet/hiera/common.d/resolv.conf.erb
+    - /etc/puppet/hiera/common/dns.d/resolv.conf.erb
+
+The default template used is `dns/templates/resolv.conf.erb`.
+
+The `hiera_file` call will look for your file in the following directories and order:
+    
+    - /etc/puppet/hiera/common.d/resolv.conf
+    - /etc/puppet/hiera/common/dns.d/resolv.conf
+
+The default file used is `dns/files/resolv.conf`.
+
+#### hiera\_dir
+
+The function `hiera_dir(key)` is quite simple, it looks somewhere in your hiera hierarchy for
+a directory named `key` and returns a hash containing with all filenames and filepaths.
+
+    { 
+      'filename1' => 'filepath1',
+      'filename2' => 'filepath2',
+      'filename3' => 'filepath3',
+      'filename4' => 'filepath4'
+    }
+
+If the directory does not exists, the function simple returns `{}`.
+
+If we use the hiera.yaml defined before and called `hiera_dir('repos')` in our 
+dns module init.pp manifest, hiera would look `repos` directory in the following paths:
+
+    - /etc/puppet/hiera/common.d/repos
+    - /etc/puppet/hiera/common/dns.d/repos

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/hiera-fs.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hierafs/version'
+
+Gem::Specification.new do |s|
+  s.name        = "hiera-fs"
+  s.version     = HieraFs::VERSION
+  s.platform    = Gem::Platform::RUBY
+
+  s.authors     = "Alan Castro"
+  s.email       = "alanclic@gmail.com"
+  s.homepage    = "http://github.com/alancastro/hiera-fs"
+  s.summary     = "File system hiera backend"
+  s.description = <<-DESCRIPTION
+    File system hiera backend.
+  DESCRIPTION
+
+  s.license  = 'MIT'
+
+  s.files        = %x[git ls-files].split($/)
+  s.require_paths = ['lib']
+
+end

data/lib/hiera/backend/fs_backend.rb

@@ -0,0 +1,56 @@
+class Hiera
+  module Backend
+    class Fs_backend
+
+      def initialize
+        Hiera.debug("[HieraFs]::Hiera fs backend starting")
+      end
+
+      def lookup(key, scope, order_override, resolution_type)
+        answer = nil
+
+        calling_class = scope.resource.name.to_s.downcase
+        calling_module = calling_class.split("::").first
+
+        Hiera.debug("[HieraFs]::calling_class: #{calling_class}")
+        Hiera.debug("[HieraFs]::calling_module: #{calling_module}")
+        Hiera.debug("[HieraFs]::Looking up #{key} in fs backend")
+
+        Backend.datasources(scope, order_override) do |source|
+          Hiera.debug("[HieraFs]::Looking for data source '#{source}'")
+
+          datadir = Backend.datafile(:fs, scope, source, "d") or next
+
+          abs_path = validate_key_lookup!(datadir, key)
+
+          next unless File.exist?(abs_path)
+
+          case resolution_type
+          when :array
+            answer ||= []
+            answer << abs_path
+          else
+            answer = abs_path
+            break
+          end
+        end
+
+        answer
+      end
+
+      def validate_key_lookup!(datadir, key)
+
+        # Expand the datadir and path, and ensure that the datadir contains
+        # the given key. If the expanded key is outside of the datadir then
+        # this is a directory traversal attack and should be aborted.
+        abs_datadir = File.expand_path(datadir)
+        abs_path    = File.expand_path(File.join(abs_datadir, key))
+        unless abs_path.index(abs_datadir) == 0
+          raise Exception, "Hiera File backend: key lookup outside of datadir '#{key}'"
+        end
+        return abs_path
+      end
+
+    end
+  end
+end

data/lib/hierafs/utils.rb

@@ -0,0 +1,61 @@
+module HieraFs
+  module Utils
+    class << self
+
+      # Returns a default file/template for hiera_file and hiera_template function.
+      # It looks in the module templates/ or files/ directories for a default file/template
+      def get_default_source(scope, key, source)
+
+        raise(Exception, "source must be either :template or :file") if source != :template and source != :file
+        default_dir = "#{source.to_s}s"
+
+        # if the function is not called from a module
+        # assume that there is no default template
+        if scope.resource.type.to_s.downcase == 'node' || scope.resource.name.to_s.downcase == 'main'
+          return nil
+        end
+
+        # manifest file that called the function
+        manifest_file = scope.source.file
+
+        arr = manifest_file.split(File::SEPARATOR)
+        # let's assume that files and templates folders are in the same level as manifests/
+        # @todo if there is a module called manifests, this will cause a bug - fix it!
+        module_path = arr.slice(0, arr.index('manifests')).join(File::SEPARATOR)
+        module_source_path = File.join(module_path, default_dir)
+
+        default_source = File.join(module_source_path, key)
+        if File.exists?(default_source)
+          return default_source
+        else
+          return nil
+        end
+
+      end
+
+      # Returns a hash (filename, filepath) with files found in a list of directories
+      def get_files_in_dirs(dirs)
+
+        all_files_in_hierarchy = {}
+
+        dirs.each do |dir|
+          raise(Puppet::ParseError, "Could not find data item #{key} in any Hiera data file and no default supplied") if dir.nil?
+          raise(Puppet::ParseError, "Directory: #{dir} does not exists") unless File.exists?(dir)
+          raise(Puppet::ParseError, "#{dir} is not a directory") unless File.directory?(dir)
+
+          files_in_dir = Dir.entries(dir).select { |f| File.file?(File.join(dir, f)) }
+
+          Puppet.debug("Files in #{dir}: #{files_in_dir}")
+
+          files_hash = Hash[ files_in_dir.map{ |f| [f, File.join(dir, f)] } ]
+          all_files_in_hierarchy = files_hash.merge(all_files_in_hierarchy)
+
+        end
+
+        return all_files_in_hierarchy
+
+      end
+
+    end
+  end
+end

data/lib/hierafs/version.rb

@@ -0,0 +1,3 @@
+module HieraFs
+  VERSION = '0.0.1'
+end

data/lib/puppet/parser/functions/hiera_dir.rb

@@ -0,0 +1,22 @@
+# @TODO document this
+module Puppet::Parser::Functions
+
+  newfunction(:hiera_dir, :type => :rvalue) do |*args|
+
+    require 'hierafs/utils'
+    require 'hiera_puppet'
+
+    key = args[0]
+    override = args[1]
+
+    answer = HieraPuppet.lookup(key, [], self, override, :array)
+
+    all_files_in_hierarchy = HieraFs::Utils::get_files_in_dirs(answer)
+
+    Puppet.debug "HieraFs::hiera_dir - Found files: #{all_files_in_hierarchy}"
+
+    return all_files_in_hierarchy
+
+  end
+
+end

data/lib/puppet/parser/functions/hiera_file.rb

@@ -0,0 +1,27 @@
+# @TODO document this
+module Puppet::Parser::Functions
+
+  newfunction(:hiera_file, :type => :rvalue) do |*args|
+
+    require 'hierafs/utils'
+    require 'hiera_puppet'
+
+    key = args[0]
+    override = args[1]
+
+    default_file = HieraFs::Utils::get_default_source(self, key, :file)
+    Puppet.debug("HieraFs::hiera_file - Default file: #{default_file}")
+
+    answer = HieraPuppet.lookup(key, default_file, self, override, :priority)
+
+    raise(Puppet::ParseError, "Could not find data item #{key} in any Hiera data file and no default supplied") if answer.nil?
+    raise(Puppet::ParseError, "File: #{answer} does not exists") unless File.exists?(answer)
+    raise(Puppet::ParseError, "File: #{answer} is not a file") unless File.file?(answer)
+
+    content = File.read(answer)
+
+    return content
+
+  end
+
+end

data/lib/puppet/parser/functions/hiera_template.rb

@@ -0,0 +1,33 @@
+# @TODO document this
+module Puppet::Parser::Functions
+
+  newfunction(:hiera_template, :type => :rvalue) do |*args|
+
+    require 'hierafs/utils'
+    require 'hiera_puppet'
+
+    Puppet.debug "In hiera_template function"
+
+    key = args[0]
+    override = args[1]
+
+    Puppet.debug "key: #{key} override: #{override}"
+
+    default_template_file = HieraFs::Utils::get_default_source(self, key, :template)
+    Puppet.debug("Default template: #{default_template_file}")
+
+    answer = HieraPuppet.lookup(key, default_template_file, self, override, :priority)
+    debug "Answer: #{answer}"
+    raise(Puppet::ParseError, "Could not find data item #{key} in any Hiera data file and no default supplied") if answer.nil?
+    raise(Puppet::ParseError, "Template file: #{answer} does not exists") unless File.exists?(answer)
+    raise(Puppet::ParseError, "Template file: #{answer} is not a file") unless File.file?(answer)
+
+    # loading template function
+    Puppet::Parser::Functions.function('template')
+    content = function_template([answer])
+
+    return content
+
+  end
+
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification 
+name: hiera-fs
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Alan Castro
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2014-04-11 00:00:00 Z
+dependencies: []
+
+description: "    File system hiera backend.\n"
+email: alanclic@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- hiera-fs.gemspec
+- lib/hiera/backend/fs_backend.rb
+- lib/hierafs/utils.rb
+- lib/hierafs/version.rb
+- lib/puppet/parser/functions/hiera_dir.rb
+- lib/puppet/parser/functions/hiera_file.rb
+- lib/puppet/parser/functions/hiera_template.rb
+homepage: http://github.com/alancastro/hiera-fs
+licenses: 
+- MIT
+metadata: {}
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - &id001 
+    - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id001
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: File system hiera backend
+test_files: []
+