hieracles 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 576b1abbe8d06fcf61896855b5474ed2d549e277
-  data.tar.gz: 79022f2d38d33472e1e629724ebc4882c7718ba3
+  metadata.gz: 40e11515e3204a93d07953d15d29185a1b1881ad
+  data.tar.gz: 3e3c04ef13bbdab8d989ef49ddb3182eadae3007
 SHA512:
-  metadata.gz: fd35c1ac42aca8724d507904387fb8bbd9543977482bd47e12e8e6301ec09e31ad655521b25904cd99c155caa5bb1ad1799e4e2ee3e4008fdc76f5582eb01139
-  data.tar.gz: 8a0528fd874dc417140713ac28858f131f0d858a843e4df1d07861934e7ac57d18061201ba360876333f986457be88f1365c94562d50b5d50331162b77cedc81
+  metadata.gz: c1ff0c0467ec5f1d8128080e57559f2e0202cfa93b06389954fa70c25f7d887f4203bd2b5dd128e3c252e129dadfe16454a371471f49d8292fad00fb5a3dd57e
+  data.tar.gz: 0f1350b7fde0e2607e66ae2e3d07c416481c371fe7b91ed139023f283ec5a5c8cc6195f9cc4a9f3f36c826c95e2fcc3f4e427a2586fd54ef2d625290031ff1ca

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Hieracles Changelog
 =======================
 
+### 0.3.1 - 2015-12-28
+- added some relevance to the registry class
+- changed the internal way to store the nodes information
+- moved Config singleton to a proper class for modularity sake
+
 ### 0.3.0 - 2015-12-16
 - added json output as an option to ppdb
 - added some more ppdb commands

data/bin/hc

@@ -23,15 +23,16 @@ end
  
 if Hieracles::Format.method_defined? command
   begin
-    node = Hieracles::Node.new fqdn, opt.options
+    config = Hieracles::Config.new opt.options
+    node = Hieracles::Node.new fqdn, config
   rescue Exception => e
     puts "*** Error: #{e.message}"
     exit(1)
   end
   begin
-    formatter = Object.const_get("Hieracles::Formats::#{Hieracles::Config.format}")
+    formatter = Object.const_get("Hieracles::Formats::#{config.format}")
   rescue
-    puts "*** Unknown format #{Hieracles::Config.format}"
+    puts "*** Unknown format #{config.format}"
     exit(1)
   end
   dispatch = formatter.new node

data/bin/ppdb

@@ -31,9 +31,9 @@ else
   exit(1)
 end
   
-Hieracles::Config.load opt.options
+config = Hieracles::Config.new opt.options
 
-request = Hieracles::Puppetdb::Request.new Hieracles::Config.puppetdb
+request = Hieracles::Puppetdb::Request.new config.puppetdb
 meth = request.method(command.to_sym)
 required = request.method(command.to_sym).parameters.select { |arg| arg[0] == :req }.map { |arg| arg[1] }
 if args.length < required.length

data/lib/hieracles/config.rb

@@ -4,15 +4,13 @@ require 'yaml'
 require 'hieracles/utils'
 
 module Hieracles
-  # configuration singleton
-  module Config
+  class Config
     include Hieracles::Utils
-    extend self
 
     attr_reader :extraparams, :server, :classpath, :scope, :puppetdb, :usedb,
       :modulepath, :hierafile, :basepath, :encpath, :format, :interactive
 
-    def load(options)
+    def initialize(options)
       @options = options
       @optionfile = @options[:config] || defaultconfig
       @extraparams = extract_params(options[:params])

data/lib/hieracles/formats/console.rb

@@ -13,9 +13,9 @@ module Hieracles
         "\e[33m%s\e[0m",
         "\e[34m%s\e[0m",
         "\e[35m%s\e[0m",
-        "\e[36m%s\e[0m",
         "\e[37m%s\e[0m",
         "\e[38m%s\e[0m",
+        "\e[36m%s\e[0m",
         "\e[97m%s\e[0m",
         "\e[35;1m%s\e[0m"
       ]
@@ -85,28 +85,29 @@ module Hieracles
       def build_params_line(key, value, filter)
         output = ''
         if !filter || Regexp.new(filter).match(key)
-          output << build_first(key, value.pop)
-          while value.count > 0
-            output << build_next(key, value.pop)
-          end
+          output << build_line_item(key, value)
         end
         output
       end
 
-      def build_first(key, first)
-        filecolor_index = @colors[first[:file]]
-        filecolor = COLORS[filecolor_index]
-        if is_merged? first
-          format("%s #{COLORS[5]} %s\n", "[-]", key, sanitize(first[:merged]) ) +
-          format("    #{COLORS[8]}\n", "[#{filecolor_index}] #{key} #{sanitize(first[:value])}" )
+      def build_line_item(key, value)
+        if value[:overriden]
+          format("%s #{COLORS[7]} %s\n", "[-]", key, sanitize(value[:value]) ) +
+          build_overriden(key, value[:found_in])
         else
-          format("#{filecolor} #{COLORS[5]} %s\n", "[#{filecolor_index}]", key, sanitize(first[:value]) )
+          filecolor_index = @colors[value[:file]]
+          filecolor = COLORS[filecolor_index]
+          format("#{filecolor} #{COLORS[7]} %s\n", "[#{filecolor_index}]", key, sanitize(value[:value]) )
         end
       end
 
-      def build_next(key, overriden)
-        filecolor_index = @colors[overriden[:file]]
-        format("    #{COLORS[8]}\n", "[#{filecolor_index}] #{key} #{overriden[:value]}")
+      def build_overriden(key, found_in)
+        back = ''
+        found_in.each do |v|
+          filecolor_index = @colors[v[:file]]
+          back << format("    #{COLORS[8]}\n", "[#{filecolor_index}] #{key} #{v[:value]}")
+        end
+        back
       end
 
       def build_modules_line(key, value)

data/lib/hieracles/formats/csv.rb

@@ -32,16 +32,13 @@ module Hieracles
       def build_params_line(key, value, filter)
         output = ''
         if !filter || Regexp.new(filter).match(key)
-          first = value.pop
-          if is_merged? first
-            output << build_line('-', key, first[:merged])
-            output << build_line(first[:file], key, first[:value], '1')
+          if value[:overriden]
+            output << build_line('-', key, value[:value])
+            value[:found_in].each do |v|
+              output << build_line(v[:file], key, v[:value], '1')
+            end
           else
-            output << build_line(first[:file], key, first[:value])
-          end
-          while value.count > 0
-            overriden = value.pop
-            output << build_line(overriden[:file], key, overriden[:value], '1')
+            output << build_line(value[:file], key, value[:value])
           end
         end
         output

data/lib/hieracles/formats/plain.rb

@@ -60,23 +60,31 @@ module Hieracles
       def build_params_line(key, value, filter)
         output = ''
         if !filter || Regexp.new(filter).match(key)
-          first = value.pop
-          filecolor_index = @index[first[:file]]
-          if is_merged? first
-            output << "[-] #{key} #{first[:merged]}\n"
-            output << "    [#{filecolor_index}] #{key} #{first[:value]}\n"
-          else
-            output << "[#{filecolor_index}] #{key} #{first[:value]}\n"
-          end
-          while value.count > 0
-            overriden = value.pop
-            filecolor_index = @index[overriden[:file]]
-            output << "    [#{filecolor_index}] #{key} #{overriden[:value]}\n"
-          end
+          output << build_line_item(key, value)
         end
         output
       end
 
+      def build_line_item(key, value)
+        if value[:overriden]
+          "[-] #{key} #{value[:value]}\n" +
+          build_overriden(key, value[:found_in])
+        else
+          filecolor_index = @index[value[:file]]
+          "[#{filecolor_index}] #{key} #{value[:value]}\n"
+        end
+      end
+
+      def build_overriden(key, found_in)
+        back = ''
+        found_in.each do |v|
+          filecolor_index = @index[v[:file]]
+          back << "    [#{filecolor_index}] #{key} #{v[:value]}\n"
+        end
+        back
+      end
+
+
       def build_modules_line(key, value)
         length = max_key_length(@node.modules) + 3
         format("%-#{length}s %s\n", key, value)

data/lib/hieracles/formats/yaml.rb

@@ -39,7 +39,7 @@ module Hieracles
 
       def commented_yaml_tree(filter, without_common = true)
         tree = @node.params_tree(without_common)
-        params = Hash[@node.params(without_common)]
+        params = @node.params(without_common)
         mergetree('---', [], tree, params)
       end
 
@@ -61,13 +61,8 @@ module Hieracles
         aryaml = yaml.each_line.map do |l|
           indent + l
         end
-        if @node.hiera.merge_behavior == :deep ||
-           @node.hiera.merge_behavior == :deeper 
-          params[key.join('.')].each do |f|
-            output += "\n" + indent + "# " + f[:file]
-          end
-        else
-          output += "\n" + indent + "# " + params[key.join('.')].last[:file]
+        params[key.join('.')][:found_in].each do |k|
+          output += "\n" + indent + "# " + k[:file]
         end
         output += "\n" + aryaml.join().chomp
         output        
@@ -101,12 +96,10 @@ module Hieracles
 
       def added(output, key, leaf, params)
         output += leaf.to_s
-        if params["#{key.join('.')}"]
-          params["#{key.join('.')}"].each do |k|
-            if k[:value].to_s == leaf.to_s
-              output += " # " + k[:file]
-              break
-            end
+        k = params["#{key.join('.')}"]
+        if k
+          k[:found_in].each do |i|
+            output += " # " + i[:file]
           end
         end
         output

data/lib/hieracles/hiera.rb

@@ -1,15 +1,16 @@
 module Hieracles
   class Hiera
 
-    def initialize
-      raise IOError, "Hierafile #{Config.hierafile} not found." unless File.exist? Config.hierafile
-      @hierafile = Config.hierafile
+    def initialize(config)
+      @config = config
+      raise IOError, "Hierafile #{@config.hierafile} not found." unless File.exist? @config.hierafile
+      @hierafile = @config.hierafile
       @loaded = YAML.load_file(@hierafile)
     end
 
     def datapath
       raise TypeError, "Sorry hieracles only knows yaml backend for now." unless @loaded[:yaml]
-      parampath = File.expand_path(File.join(Config.basepath, datadir))
+      parampath = File.expand_path(File.join(@config.basepath, datadir))
       raise IOError, "Params dir #{parampath} not found." unless Dir.exist? parampath
       parampath
     end

data/lib/hieracles/node.rb

@@ -10,21 +10,21 @@ module Hieracles
 
     attr_reader :hiera_params, :hiera, :facts, :notifications
 
-    def initialize(fqdn, options)
+    def initialize(fqdn, config)
       @fqdn = fqdn
-      Config.load(options)
-      @hiera = Hieracles::Hiera.new
+      @config = config
+      @hiera = Hieracles::Hiera.new @config
       @hiera_params = { fqdn: @fqdn }.
         merge(get_hiera_params(@fqdn)).
-        merge(Config.extraparams)
+        merge(@config.extraparams)
       @facts = deep_sort(@hiera_params.
-        merge(Config.scope).
+        merge(@config.scope).
         merge(puppet_facts))
     end
 
     def get_hiera_params(fqdn)
-      @__hiera_params ||= if File.exist?(File.join(Config.encpath, "#{fqdn}.yaml"))
-        load = YAML.load_file(File.join(Config.encpath, "#{fqdn}.yaml"))
+      @__hiera_params ||= if File.exist?(File.join(@config.encpath, "#{fqdn}.yaml"))
+        load = YAML.load_file(File.join(@config.encpath, "#{fqdn}.yaml"))
         sym_keys(load['parameters']).merge({ classes: load['classes']})
       else
         raise "Node not found"
@@ -33,7 +33,7 @@ module Hieracles
 
     def files(without_common = true)
       @__files ||= @hiera.hierarchy.reduce([]) do |a, f|
-        file = parse("#{f}.yaml", @facts, Config.interactive)
+        file = parse("#{f}.yaml", @facts, @config.interactive)
         if file && 
            File.exist?(File.join(@hiera.datapath, file)) &&
            (!without_common ||
@@ -45,25 +45,56 @@ module Hieracles
     end
 
     def paths(without_common = true)
-      files(without_common).map { |p| File.join(Config.basepath, p) }
+      files(without_common).map { |p| File.join(@config.basepath, p) }
     end
 
-    def params(without_common = true)
+    def params_old(without_common = true)
       params = {}
       files(without_common).reverse.each do |f|
-        data = YAML.load_file(File.join(Config.basepath, f))
+        data = YAML.load_file(File.join(@config.basepath, f))
         if data
           s = to_shallow_hash(data)
           s.each do |k,v|
             params[k] ||= []
-            # f needs interpolation
-            params[k] << { value: v, file: f, merged: merge_value(params[k], v) }
+            params[k] << { value: v, file: f }.merge(merge_value(params[k], v))
           end
         end
       end
       params.sort
     end
 
+    def params(without_common = true)
+      params = {}
+      files(without_common).each do |f|
+        data = YAML.load_file(File.join(@config.basepath, f))
+        if data
+          s = to_shallow_hash(data)
+          s.each do |k,v|
+            if params[k]
+              case @hiera.merge_behavior
+              when :deeper
+                params[k] = { value: v }.deep_merge!(params[k])
+              when :deep
+                params[k].deep_merge({ value: v })
+              end
+              params[k][:file] = '-'
+              params[k][:overriden] = true
+              params[k][:found_in].push({ value: v, file: f })
+            else
+              params[k] = {
+                value: v,
+                file: f,
+                overriden: false,
+                found_in: [{ value: v, file: f }]
+              }
+
+            end
+          end
+        end
+      end
+      params.sort.to_h
+    end
+
     def params_tree(without_common = true)
       params = {}
       paths(without_common).reverse.each do |f|
@@ -99,7 +130,7 @@ module Hieracles
 
     def _get_info
       extra = {}
-      if Config.usedb
+      if @config.usedb
         extra = puppetdb_info
       end
       @hiera_params.merge extra
@@ -107,12 +138,12 @@ module Hieracles
 
     def classfiles
       @hiera_params[:classes].map do |cl|
-        format(Config.classpath, cl)
+        format(@config.classpath, cl)
       end
     end
 
     def modulepath(path)
-      File.join(Config.modulepath, path)
+      File.join(@config.modulepath, path)
     end
 
     def add_modules(line, modules)
@@ -120,7 +151,7 @@ module Hieracles
         mod = $1
         mainmod = mod[/^[^:]*/]
         if Dir.exists? modulepath(mainmod)
-          modules[mod] = File.join(Config.modulepath, mainmod)
+          modules[mod] = File.join(@config.modulepath, mainmod)
         else
           modules[mod] = nil
         end
@@ -133,7 +164,7 @@ module Hieracles
     end
 
     def puppet_facts
-      if Config.usedb
+      if @config.usedb
         resp = request_db.node_facts(@fqdn)
         @notifications = resp.notifications
         if resp.total_records > 0
@@ -148,7 +179,7 @@ module Hieracles
     end
 
     def request_db
-      @_request ||= Hieracles::Puppetdb::Request.new Config.puppetdb
+      @_request ||= Hieracles::Puppetdb::Request.new @config.puppetdb
     end
 
     def merge_trees(left, right)
@@ -165,21 +196,22 @@ module Hieracles
     def merge_value(previous, value)
       if value.is_a? Array
         if previous == []
-          deep_sort(value)
+          { merged: deep_sort(value) }
         else
-          left = previous.last[:merged]
+          left = { merged: previous.last[:merged] }
+          right = { merged: value }
           case @hiera.merge_behavior
           # TODO: handle the case where right is not an array
           when :deeper
-            deep_sort(left | value)
+            deep_sort(left.deep_merge!(right))
           when :deep
-            deep_sort(left | value)
+            deep_sort(left.deep_merge(right))
           else
-            deep_sort(value)
+            deep_sort(right)
           end
         end
       else
-        value
+        { merged: value }
       end
     end
 

data/lib/hieracles/registry.rb

@@ -4,17 +4,20 @@ module Hieracles
   	extend self
 
   	def farms(config)
-  		@_farms ||= Dir.glob(format(config.classpath, '*')).sort
+  		Dir.glob(format(config.classpath, '*')).sort.map do |f|
+        sub = Regexp.new(".*#{config.classpath.sub(/%s/,'([^/]*)')}")
+        f.sub(sub, "\\1")
+      end
   	end
 
   	def nodes(config)
-  		@_nodes ||= Dir.glob(File.join(config.encpath, '*.yaml')).sort.map do |f|
+  		Dir.glob(File.join(config.encpath, '*.yaml')).sort.map do |f|
   			File.basename(f, '.yaml')
   		end
   	end
 
   	def modules(config)
-  		@_modules ||= Dir.glob(File.join(config.modulepath, '*')).sort.map do |f|
+  		Dir.glob(File.join(config.modulepath, '*')).sort.map do |f|
   			File.basename(f)
   		end
   	end

data/lib/hieracles/utils.rb

@@ -29,6 +29,11 @@ module Hieracles
       hash1.merge!(hash2, &merger)
     end
 
+    def local_merge(hash1, hash2)
+      merger = proc { |key, v1, v2| v1.is_a?(Hash) && v2.is_a?(Hash) ? v1.merge(v2, &merger) : v2 }
+      hash1.merge(hash2, &merger)
+    end
+
     def deep_sort(object)
       if object.is_a?(Hash)
         res = {}

data/spec/lib/config_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe Hieracles::Config do
-  describe '.load' do
+  describe '.new' do
     context 'with an existing file' do
       let(:options) { { config: 'spec/files/config.yml' } }
       let(:expected) do
@@ -11,13 +11,13 @@ describe Hieracles::Config do
           hierafile: File.expand_path('spec/files/hiera.yaml')
         }
       end
-      before { Hieracles::Config.load options }
+      let(:config) { Hieracles::Config.new options }
 
       it 'initialize config values' do
-        expect(Hieracles::Config.classpath).to eq expected[:classpath]
-        expect(Hieracles::Config.modulepath).to eq expected[:modulepath]
-        expect(Hieracles::Config.hierafile).to eq expected[:hierafile]
-        expect(Hieracles::Config.format).to eq 'Console'
+        expect(config.classpath).to eq expected[:classpath]
+        expect(config.modulepath).to eq expected[:modulepath]
+        expect(config.hierafile).to eq expected[:hierafile]
+        expect(config.format).to eq 'Console'
       end
     end
 
@@ -36,13 +36,13 @@ describe Hieracles::Config do
           hierafile: File.expand_path('spec/files/hiera.yaml')
         }
       end
-      before { Hieracles::Config.load options }
+      let(:config) { Hieracles::Config.new options }
 
       it 'initialize config values' do
-        expect(Hieracles::Config.classpath).to eq expected[:classpath]
-        expect(Hieracles::Config.modulepath).to eq expected[:modulepath]
-        expect(Hieracles::Config.hierafile).to eq expected[:hierafile]
-        expect(Hieracles::Config.format).to eq 'Console'
+        expect(config.classpath).to eq expected[:classpath]
+        expect(config.modulepath).to eq expected[:modulepath]
+        expect(config.hierafile).to eq expected[:hierafile]
+        expect(config.format).to eq 'Console'
       end
     end
 
@@ -53,8 +53,8 @@ describe Hieracles::Config do
             config: 'spec/files/config_withdb.yml'
           }
         end
-        before { Hieracles::Config.load options }
-        it { expect(Hieracles::Config.usedb).to be true }
+        let(:config) { Hieracles::Config.new options }
+        it { expect(config.usedb).to be true }
       end
       context 'with nodb passed as param' do
         let(:options) do
@@ -63,8 +63,8 @@ describe Hieracles::Config do
             nodb: true
           }
         end
-        before { Hieracles::Config.load options }
-        it { expect(Hieracles::Config.usedb).to be false }
+        let(:config) { Hieracles::Config.new options }
+        it { expect(config.usedb).to be false }
       end
     end
 
@@ -76,8 +76,8 @@ describe Hieracles::Config do
             db: true
           }
         end
-        before { Hieracles::Config.load options }
-        it { expect(Hieracles::Config.usedb).to be true }
+        let(:config) { Hieracles::Config.new options }
+        it { expect(config.usedb).to be true }
       end
     end
 
@@ -89,30 +89,40 @@ describe Hieracles::Config do
           basepath: 'spec/files'
         }
       end
-      before do
-        FileUtils.rm(options[:config]) if File.exist? options[:config]
-        Hieracles::Config.load options
-      end
+      let(:config) { Hieracles::Config.new options }
       after { FileUtils.rm(options[:config]) if File.exist? options[:config] }
 
       it 'creates a default config file' do
+        config.classpath
         expect(File.exist? options[:config]).to be true
       end
 
       it 'initialize config values' do
-        expect(Hieracles::Config.classpath).to eq File.expand_path('spec/files/manifests/classes/%s.pp')
+        expect(config.classpath).to eq File.expand_path('spec/files/manifests/classes/%s.pp')
       end
     end
   end
 
-  describe '.defaultconfig' do
-    it { expect(Hieracles::Config.defaultconfig).not_to eq nil }
-  end
+  # describe '.defaultconfig' do
+  #   let(:config) { Hieracles::Config.new Hash.new }
+  #   before {
+  #     allow(config).
+  #       to receive(:defaultconfig).
+  #       and_return('spec/files/config.yml')
+  #   }
+  #   it { expect(config.defaultconfig).not_to eq nil }
+  # end
 
   describe '.extract_params' do
+      let(:options) do
+        { 
+          config: 'spec/files/config.yml'
+        }
+      end
     let(:str)  { 'bla=blu;one=two' }
     let(:expected) { { bla: 'blu', one: 'two' } }
-    it { expect(Hieracles::Config.extract_params(str)).to eq expected }
+    let(:config) { Hieracles::Config.new options }
+    it { expect(config.extract_params(str)).to eq expected }
   end
 
   describe '.scope' do
@@ -124,9 +134,9 @@ describe Hieracles::Config do
         }
       end
       let(:expected) { 'Debian' }
-      before { Hieracles::Config.load options }
+      let(:config) { Hieracles::Config.new options }
 
-      it { expect(Hieracles::Config.scope[:osfamily]).to eq expected }
+      it { expect(config.scope[:osfamily]).to eq expected }
     end
     context 'with a json file' do
       let(:options) do
@@ -136,21 +146,27 @@ describe Hieracles::Config do
         }
       end
       let(:expected) { 'Debian' }
-      before { Hieracles::Config.load options }
+      let(:config) { Hieracles::Config.new options }
 
-      it { expect(Hieracles::Config.scope[:osfamily]).to eq expected }
+      it { expect(config.scope[:osfamily]).to eq expected }
     end
   end
 
   describe '.resolve_path' do
+    let(:options) do
+      { 
+        config: 'spec/files/config.yml'
+      }
+    end
+    let(:config) { Hieracles::Config.new options }
     context "when path is found" do
       let(:path) { 'README.md' }
       let(:expected) { File.expand_path('README.md') }
-      it { expect(Hieracles::Config.resolve_path(path)).to eq expected }
+      it { expect(config.resolve_path(path)).to eq expected }
     end
     context "when path is not found anywhere" do
       let(:path) { 'README-NOT.md' }
-      it { expect { Hieracles::Config.resolve_path(path) }.to raise_error(IOError) }
+      it { expect { config.resolve_path(path) }.to raise_error(IOError) }
     end
   end