hieracles 0.0.6 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8b4e601300916c99919b357e58d0752ec7a03e50
-  data.tar.gz: 698972e747b63ce0b80d20b929022219f7fa6401
+  metadata.gz: 3eaabaf9bb23726ac33f23fed83dc3f52983e4ee
+  data.tar.gz: 11cbdfdca5bc942d1fc84b36273f1ac6c9447303
 SHA512:
-  metadata.gz: f87602dbfde42cd11c5c5ee024075f8cb119c6e8b61d60528a4f88c9f8cd38843a1bd34ae84be42289c91aeaf756a6c48896b82f355f0eac9d70fd33de491bdd
-  data.tar.gz: 636f04f5bf4b8f9d78263d56a94cae057b3e203af84744737338eccadb3cbcad69883168dbbaa33cc6a9fbc18de9922b29008a03e4dfc790a2a2c336b5f95583
+  metadata.gz: e20bbd06da0d72acde4f62a82f4202369b6890c640cc9f2b30e01cbcbecc87b5d23be3ee68259f3ec11f4a80d7c54698a6904a8559f34b33481fd9b9a46f9679
+  data.tar.gz: 4afac468de65f1797303e66d5ba32e1d9006797c7a7cec000c30b8fda1c09370f77e424545715b529c6c86e0fe5f0f7ea927e29f99dc4e18cac433669dd93b4b

data/CHANGELOG.md

@@ -1,6 +1,13 @@
 Hieracles Changelog
 =======================
 
+### 0.1.0 - 2015-11-10
+- display full local path in params output
+- add an option to display version
+- fix yaml output for true and false cases
+- added a simple filter fetaure for yaml format,
+  but it only matches like a 'start_with'
+
 ### 0.0.6 - 2015-09-21
 - added doc on how to build the debian package
 

data/README.md

@@ -74,12 +74,13 @@ Usage
                   Also accepts a search string
 
     Extra args:
-      -f <plain|console|csv|yaml|rawyaml> default console
+      -f <plain|console|csv|yaml|rawyaml> - default console
       -p extraparam=what;anotherparam=this 
       -c <configfile>
       -h <hierafile>
       -b <basepath> default ./
       -e <encdir>
+      -v - displays version
 
 Completion
 -------------
@@ -112,6 +113,19 @@ and install
 
     dpkg -i hieracles_0.0.6-1_all.deb
 
+Todo
+--------------
+- add json format
+- add override information in yaml format
+- add a command to search for node according to a filter
+- add a command to find all nodes that use a given module
+- add a command that finds all nodes for which a params is defined
+- detect unused params
+- create a repl, which at launch reads all data so the queries are blazing fast
+- adapt to other ENCs
+- adapt to puppetdb storage
+
+
 Authors
 -----------
 Hieracles original code is writen by [@mose](https://github.com/mose).

data/bin/hc

@@ -6,6 +6,11 @@ require 'hieracles'
 
 opt = Hieracles::Optparse.new(ARGV)
 
+if opt.options.has_key? :version
+  puts Hieracles.version
+  exit(0)
+end
+
 fqdn = opt.payload[0]
 command = opt.payload[1]
 args = opt.payload[2..-1]

data/hieracles.gemspec

@@ -13,8 +13,62 @@ Gem::Specification.new do |spec|
   spec.metadata      = { "changelog" => "https://github.com/Gandi/hieracles/blob/master/CHANGELOG.md" }
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0")
-  #spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.files         = %w(
+                        CHANGELOG.md
+                        Gemfile
+                        LICENSE
+                        README.md
+                        Rakefile
+                        bin/hc
+                        hieracles.gemspec
+                        lib/hieracles.rb
+                        lib/hieracles/config.rb
+                        lib/hieracles/format.rb
+                        lib/hieracles/formats/console.rb
+                        lib/hieracles/formats/csv.rb
+                        lib/hieracles/formats/plain.rb
+                        lib/hieracles/formats/rawyaml.rb
+                        lib/hieracles/formats/yaml.rb
+                        lib/hieracles/help.rb
+                        lib/hieracles/hiera.rb
+                        lib/hieracles/node.rb
+                        lib/hieracles/optparse.rb
+                        lib/hieracles/registry.rb
+                        lib/hieracles/utils.rb
+                        spec/files/config.yml
+                        spec/files/enc/server.example.com.yaml
+                        spec/files/enc/server2.example.com.yaml
+                        spec/files/enc/server3.example.com.yaml
+                        spec/files/enc/server4.example.com.yaml
+                        spec/files/farm_modules/dev.pp
+                        spec/files/farm_modules/dev2.pp
+                        spec/files/farm_modules/dev4.pp
+                        spec/files/hiera.yaml
+                        spec/files/hiera_no_yamlbackend.yaml
+                        spec/files/hiera_yamlbackend_notfound.yaml
+                        spec/files/modules/fake_module/manifests/init.pp
+                        spec/files/modules/fake_module2/manifests/init.pp
+                        spec/files/modules/fake_module3/manifests/init.pp
+                        spec/files/modules/faux_module1/manifests/init.pp
+                        spec/files/modules/faux_module2/manifests/init.pp
+                        spec/files/params/common/common.yml
+                        spec/files/params/farm/dev.yaml
+                        spec/files/params/nodes/server.example.com.yaml
+                        spec/lib/config_spec.rb
+                        spec/lib/format_spec.rb
+                        spec/lib/formats/console_spec.rb
+                        spec/lib/formats/csv_spec.rb
+                        spec/lib/formats/plain_spec.rb
+                        spec/lib/formats/rawyaml_spec.rb
+                        spec/lib/formats/yaml_spec.rb
+                        spec/lib/help_spec.rb
+                        spec/lib/hiera_spec.rb
+                        spec/lib/node_spec.rb
+                        spec/lib/optparse_spec.rb
+                        spec/lib/registry_spec.rb
+                        spec/lib/utils_spec.rb
+                        spec/spec_helper.rb
+                        )
   spec.executables   = ['hc']
   spec.test_files    = spec.files.grep(%r{^spec/})
   spec.require_paths = ["lib"]

data/lib/hieracles/formats/yaml.rb

@@ -19,15 +19,21 @@ module Hieracles
         @node.modules.to_yaml
       end
 
-      def params(args)
-        commented_yaml_tree(true)
+      def params(args = nil)
+        if args 
+          args = args.join(' ')
+        end
+        commented_yaml_tree(args, true)
       end
 
-      def allparams(args)
-        commented_yaml_tree(false)
+      def allparams(args = nil)
+        if args 
+          args = args.join('.')
+        end
+        commented_yaml_tree(args, false)
       end
 
-      def commented_yaml_tree(without_common = true)
+      def commented_yaml_tree(filter, without_common = true)
         tree = @node.params_tree(without_common)
         params = Hash[@node.params(without_common)]
         mergetree('---', [], tree, params)
@@ -64,6 +70,22 @@ module Hieracles
         output
       end
 
+      def add_trueclass(output, key, leaf, params, indent)
+        output += 'true'
+        if params["#{key.join('.')}"]
+          output += " # " + params[key.join('.')][0][:file]
+        end
+        output
+      end
+
+      def add_falseclass(output, key, leaf, params, indent)
+        output += 'false'
+        if params["#{key.join('.')}"]
+          output += " # " + params[key.join('.')][0][:file]
+        end
+        output
+      end
+
     end
   end
 end

data/lib/hieracles/help.rb

@@ -29,6 +29,7 @@ module Hieracles
         -h <hierafile>
         -b <basepath> default ./
         -e <encdir>
+        -v just displays the version of Hieracles
       END
     end
   end

data/lib/hieracles/hiera.rb

@@ -8,9 +8,9 @@ module Hieracles
       @loaded = YAML.load_file(@hierafile)
     end
 
-    def datadir
+    def datapath
       raise TypeError, "Sorry hieracles only knows yaml backend for now." unless @loaded[:yaml]
-      parampath = File.expand_path(File.join(Config.basepath, @loaded[:yaml][:datadir]))
+      parampath = File.expand_path(File.join(Config.basepath, datadir))
       raise IOError, "Params dir #{parampath} not found." unless Dir.exist? parampath
       parampath
     end
@@ -19,6 +19,10 @@ module Hieracles
       @loaded[:hierarchy]
     end
 
+    def datadir
+      @loaded[:yaml][:datadir]
+    end
+
     def params
       hierarchy.join(',').scan(/%\{(?:::)?([^\}]*)\}/).flatten.uniq
     end

data/lib/hieracles/node.rb

@@ -30,23 +30,23 @@ module Hieracles
       @hiera.hierarchy.reduce([]) do |a, f|
         file = format("#{f}.yaml", @hiera_params) rescue nil
         if file && 
-           File.exist?(File.join(@hiera.datadir, file)) &&
+           File.exist?(File.join(@hiera.datapath, file)) &&
            (!without_common ||
            !file[/common/])
-          a << file
+          a << File.join(@hiera.datadir, file)
         end
         a
       end
     end
 
     def paths(without_common = true)
-      files(without_common).map { |p| File.join(@hiera.datadir, p) }
+      files(without_common).map { |p| File.join(Config.basepath, p) }
     end
 
     def params(without_common = true)
       params = {}
       files(without_common).each do |f|
-        data = YAML.load_file(File.join(@hiera.datadir, f))
+        data = YAML.load_file(File.join(Config.basepath, f))
         s = to_shallow_hash(data)
         s.each do |k,v|
           params[k] ||= []

data/lib/hieracles/optparse.rb

@@ -28,6 +28,10 @@ module Hieracles
       encpath: {
         has_arg: true,
         aliases: ['e', 'encpath']
+      },
+      version: {
+        has_arg: false,
+        aliases: ['v', 'version']
       }
     }
 

data/lib/hieracles/registry.rb

@@ -0,0 +1,23 @@
+
+module Hieracles
+  module Registry
+  	extend self
+
+  	def farms(config)
+  		@_farms ||= Dir.glob(File.join(config.basepath, format(config.classpath, '*'))).sort
+  	end
+
+  	def nodes(config)
+  		@_nodes ||= Dir.glob(File.join(config.basepath, config.encpath, '*.yaml')).sort.map do |f|
+  			File.basename(f, '.yaml')
+  		end
+  	end
+
+  	def modules(config)
+  		@_modules ||= Dir.glob(File.join(config.basepath, config.modulepath, '*')).sort.map do |f|
+  			File.basename(f)
+  		end
+  	end
+
+	end
+end

data/lib/hieracles.rb

@@ -5,6 +5,7 @@ require 'hieracles/utils'
 require 'hieracles/help'
 require 'hieracles/node'
 require 'hieracles/format'
+require 'hieracles/registry'
 require 'hieracles/formats/csv'
 require 'hieracles/formats/yaml'
 require 'hieracles/formats/plain'
@@ -13,4 +14,7 @@ require 'hieracles/formats/rawyaml'
 
 # https://github.com/Gandi/hieracles
 module Hieracles
+  def self.version
+    File.read(File.expand_path('../../CHANGELOG.md', __FILE__))[/([0-9]+\.[0-9]+\.[0-9]+)/]
+  end
 end

data/spec/lib/hiera_spec.rb

@@ -7,6 +7,7 @@ describe Hieracles::Hiera do
 
     context 'hiera file not found' do
       let(:options) { { 
+        config: 'spec/files/config.yml',
         basepath: 'spec/files',
         hierafile: 'hiera_no.yaml' 
       } }
@@ -17,6 +18,7 @@ describe Hieracles::Hiera do
     
     context 'hiera file found' do
       let(:options) { { 
+        config: 'spec/files/config.yml',
         basepath: 'spec/files',
         hierafile: 'hiera.yaml' 
       } }
@@ -32,25 +34,27 @@ describe Hieracles::Hiera do
 
   end
 
-  describe '.datadir' do
+  describe '.datapath' do
     context 'hiera file do not have a yaml backend' do
       let(:options) { { 
+        config: 'spec/files/config.yml',
         basepath: 'spec/files',
         hierafile: 'hiera_no_yamlbackend.yaml' 
       } }
       let(:hiera) { Hieracles::Hiera.new }
       it 'raises an error' do
-        expect { hiera.datadir }.to raise_error(TypeError)
+        expect { hiera.datapath }.to raise_error(TypeError)
       end
     end
     context 'hiera file has a yaml backend but dir not found' do
       let(:options) { { 
+        config: 'spec/files/config.yml',
         basepath: 'spec/files',
         hierafile: 'hiera_yamlbackend_notfound.yaml' 
       } }
       let(:hiera) { Hieracles::Hiera.new }
       it 'raises an error' do
-        expect { hiera.datadir }.to raise_error(IOError)
+        expect { hiera.datapath }.to raise_error(IOError)
       end
     end
     context 'hiera file has a yaml backend' do
@@ -64,16 +68,31 @@ describe Hieracles::Hiera do
       let(:hiera) { Hieracles::Hiera.new }
       let(:expected) { File.expand_path(File.join(Hieracles::Config.basepath, 'params')) }
       it 'returns params path' do
-        expect(hiera.datadir).to eq expected
+        expect(hiera.datapath).to eq expected
       end
     end
   end
 
+  describe '.datadir' do
+    let(:options) {
+      {
+        config: 'spec/files/config.yml',
+        hierafile: 'hiera.yaml',
+        basepath: 'spec/files'
+      }
+    }
+    let(:hiera) { Hieracles::Hiera.new }
+    it { expect(hiera.datadir).to eq 'params/' }
+  end
+
   context "with proper params" do
-    let(:options) { { 
-      basepath: 'spec/files',
-      hierafile: 'hiera.yaml' 
-    } }
+    let(:options) {
+      { 
+        config: 'spec/files/config.yml',
+        basepath: 'spec/files',
+        hierafile: 'hiera.yaml' 
+      }
+    }
     let(:hiera) { Hieracles::Hiera.new }
 
     describe '.hierarchy' do

data/spec/lib/node_spec.rb

@@ -57,8 +57,8 @@ describe Hieracles::Node do
     describe '.files' do
       let(:expected) {
         [
-          'nodes/server.example.com.yaml',
-          'farm/dev.yaml'
+          'params/nodes/server.example.com.yaml',
+          'params/farm/dev.yaml'
         ]
       }
       it { expect(node.files).to eq expected }
@@ -67,8 +67,8 @@ describe Hieracles::Node do
     describe '.paths' do
       let(:expected) {
         [
-          File.join(node.hiera.datadir, 'nodes/server.example.com.yaml'),
-          File.join(node.hiera.datadir, 'farm/dev.yaml')
+          File.join(node.hiera.datapath, 'nodes/server.example.com.yaml'),
+          File.join(node.hiera.datapath, 'farm/dev.yaml')
         ]
       }
       it { expect(node.paths).to eq expected }
@@ -80,19 +80,19 @@ describe Hieracles::Node do
           [ "another.sublevel.thing", 
             [{
               value: "always",
-              file: 'nodes/server.example.com.yaml'
+              file: 'params/nodes/server.example.com.yaml'
             }]
           ],
           [ "common_param.subparam",
             [{
               value: "overriden", 
-              file: 'nodes/server.example.com.yaml'
+              file: 'params/nodes/server.example.com.yaml'
             }]
           ], 
           [ "somefarmparam", 
             [{
               value: false,
-              file: 'farm/dev.yaml'
+              file: 'params/farm/dev.yaml'
             }]
           ]
         ]

data/spec/lib/registry_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe Hieracles::Registry do
+	let(:base) { File.expand_path('../../../', __FILE__)}
+
+  describe '.farms' do
+    let(:options) do
+      { config: 'spec/files/config.yml', basepath: 'spec/files' }
+    end
+    let(:expected) { [
+    		File.join(base, options[:basepath], 'farm_modules', 'dev.pp'),
+    		File.join(base, options[:basepath], 'farm_modules', 'dev2.pp'),
+    		File.join(base, options[:basepath], 'farm_modules', 'dev4.pp')
+  	] }
+    before { Hieracles::Config.load options}
+    it { expect(Hieracles::Registry.farms Hieracles::Config).to eq expected }
+  end
+
+  describe '.nodes' do
+    let(:options) do
+      { config: 'spec/files/config.yml', basepath: 'spec/files' }
+    end
+    let(:expected) { [
+    		'server.example.com',
+    		'server2.example.com',
+    		'server3.example.com',
+    		'server4.example.com'
+  	] }
+    before { Hieracles::Config.load options}
+    it { expect(Hieracles::Registry.nodes Hieracles::Config).to eq expected }
+  end
+
+  describe '.modules' do
+    let(:options) do
+      { config: 'spec/files/config.yml', basepath: 'spec/files' }
+    end
+    let(:expected) { [
+    		'fake_module',
+    		'fake_module2',
+    		'fake_module3',
+    		'faux_module1',
+    		'faux_module2'
+  	] }
+    before { Hieracles::Config.load options}
+    it { expect(Hieracles::Registry.modules Hieracles::Config).to eq expected }
+  end
+
+end

data/spec/spec_helper.rb

@@ -1,20 +1,20 @@
 $LOAD_PATH << File.expand_path('../../lib', __FILE__)
-require 'rubygems'
-require 'bundler'
+# require 'rubygems'
+# require 'bundler'
 
-if ENV['COV']
-  require 'simplecov'
-  SimpleCov.profiles.define :app do
-    add_group 'bin', '/bin'
-    add_group 'lib', '/lib'
-    add_filter '/vendor/'
-    add_filter '/spec/'
-  end
-  SimpleCov.start :app
-else
-  require 'coveralls'
-  Coveralls.wear!
-end
+# if ENV['COV']
+#   require 'simplecov'
+#   SimpleCov.profiles.define :app do
+#     add_group 'bin', '/bin'
+#     add_group 'lib', '/lib'
+#     add_filter '/vendor/'
+#     add_filter '/spec/'
+#   end
+#   SimpleCov.start :app
+# else
+#   require 'coveralls'
+#   Coveralls.wear!
+# end
 
 require 'hieracles'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hieracles
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.0
 platform: ruby
 authors:
 - mose
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-21 00:00:00.000000000 Z
+date: 2015-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -102,11 +102,6 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".coveralls.yml"
-- ".gitignore"
-- ".rspec"
-- ".ruby-version"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -126,6 +121,7 @@ files:
 - lib/hieracles/hiera.rb
 - lib/hieracles/node.rb
 - lib/hieracles/optparse.rb
+- lib/hieracles/registry.rb
 - lib/hieracles/utils.rb
 - spec/files/config.yml
 - spec/files/enc/server.example.com.yaml
@@ -157,10 +153,9 @@ files:
 - spec/lib/hiera_spec.rb
 - spec/lib/node_spec.rb
 - spec/lib/optparse_spec.rb
+- spec/lib/registry_spec.rb
 - spec/lib/utils_spec.rb
 - spec/spec_helper.rb
-- tools/completion/_hc
-- tools/nodeinfo
 homepage: https://github.com/Gandi/hieracles
 licenses:
 - MIT
@@ -217,5 +212,6 @@ test_files:
 - spec/lib/hiera_spec.rb
 - spec/lib/node_spec.rb
 - spec/lib/optparse_spec.rb
+- spec/lib/registry_spec.rb
 - spec/lib/utils_spec.rb
 - spec/spec_helper.rb

data/.coveralls.yml

@@ -1,2 +0,0 @@
-service_name: travis-ci
-repo_token: MMYNBOKRQNladhirYnmkuJ3DqNSMbJh40

data/.gitignore

@@ -1,15 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-*.bundle
-*.so
-*.o
-*.a
-mkmf.log
-/vendor/

data/.rspec

@@ -1,2 +0,0 @@
---format progress
---color

data/.ruby-version

@@ -1 +0,0 @@
-2.2

data/.travis.yml

@@ -1,5 +0,0 @@
-language: ruby
-cache: bundler
-rvm:
-  - 1.9.3
-  - 2.2.2

data/tools/completion/_hc

@@ -1,13 +0,0 @@
-#compdef hc
-
-_hc() {
-  local cmd
-  if (( CURRENT == 2 ))
-  then
-    _values -C 'fqdn' ${$(find ./enc -print | xargs -- basename -s | sed -e 's~\.yaml~~')}
-  else if (( CURRENT == 3 ))
-    _values -C 'command' info files paths modules params allparams
-  fi
-}
-
-_hc

data/tools/nodeinfo

@@ -1,41 +0,0 @@
-#!/usr/bin/env ruby
-# This is a cgi script intended to be installed on 
-# puppetmasters v2.6 and v2.7
-
-require 'mysql'
-require 'cgi'
-
-cgi = CGI.new
-
-if cgi['q'].empty?
-        puts "Content-type: text/plain\n\n"
-        puts "KO"
-        exit(0)
-end
-
-DB_HOST = 'localhost'
-DB_USER = ''
-DB_PASS = ''
-DB_FIELDS = %w(farm site country)
-
-fqdn = cgi['q'].gsub(/[^-_0-9a-zA-z\.]/, '')
-QUERY = "select #{DB_FIELDS.join(', ')} from node left join datacenter dc on node.site=dc.datacenter where nodename='#{fqdn}';"
-DB = "puppet"
-
-
-begin
-    puts "Content-type: text/plain\n\n"
-    con = Mysql.new DB_HOST, DB_USER, DB_PASS
-    rs = con.query "use " + DB
-    rs = con.query QUERY
-    rs.each do |r|
-        puts r.join(',')
-    end
-
-rescue Mysql::Error => e
-    puts e.errno
-    puts e.error
-
-ensure
-    con.close if con
-end