hieracles 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b9af763f884a9153607dbc67b10cc0fcd0eb79c8
-  data.tar.gz: 0fc7b717a7a598c3a78245dd18761a11140629cd
+  metadata.gz: 9456a3fe61cef7f54210ecd5d1c0db375afce266
+  data.tar.gz: 4d7563bd18c44b03267bf19bfecf6c8f90d5c7c4
 SHA512:
-  metadata.gz: 296005bd9070c34848c6f53cdb0e03a4e6b099cf2ac06bc97c5d543a8bf4a89cd40187e7cfd643cb0615867fb9be2d4f8e5618522f9bcb2cd498322d0c9d2281
-  data.tar.gz: 4f251c0dcd1143cffadfc09484af1eaf06af19d671b166d1b49d0b96d4e3ab80804bf20381a9af5b42384e4a79072610caed2e8a83c70ef0aed0b5d1502b28fd
+  metadata.gz: dafdb9eb00ae8883c9a365724e86af97e819bcb70ea774a00342fb0d7cb2e6231eb1b9df1be562ef3bf88cd444524deebfb50e80c59d77335f8f0aa8935dfb16
+  data.tar.gz: faf09ad63a05cd373e8fd7a1a2f13f772580dca3f1a3b34efe599b9d20d6f5493c268236c6c945798bd131bf040c60dbeea83deed892806d7ffbebfa9d2e6d3c

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 Hieracles Changelog
 =======================
 
+### 0.0.2 - 2016-09-16
+- added `yaml` format including comments about where the params is defined
+- the uncommented yaml is now the format `rawyaml`
+
 ### 0.0.1 - 2015-09-12
 - first alpha release
 - added extensive testing using rspec

data/README.md

@@ -1,6 +1,8 @@
 Hieracles
 ================
 
+[![Gem Version](https://img.shields.io/gem/v/hieracles.svg)](http://rubygems.org/gems/hieracles)
+[![Downloads](http://img.shields.io/gem/dt/hieracles.svg)](https://rubygems.org/gems/hieracles)
 [![Build Status](https://img.shields.io/travis/Gandi/hieracles.svg)](https://travis-ci.org/Gandi/hieracles)
 [![Coverage Status](https://img.shields.io/coveralls/Gandi/hieracles.svg)](https://coveralls.io/r/Gandi/hieracles?branch=master)
 [![Dependency Status](https://img.shields.io/gemnasium/Gandi/hieracles.svg)](https://gemnasium.com/Gandi/hieracles)
@@ -8,9 +10,92 @@ Hieracles
 
 Hieracles is a command-line tool for analysis and deep examination of [Hiera][hiera] paramaters in a [Puppet][puppet] setup. It's used internally at [Gandi][gandi] and its first incarnation is strongly tied to Gandi puppet architecture. But Hieracles tends to become, in time, a generic Hiera overlay visualisation tool.
 
+Prerequisite
+---------------
+
+There are many ways to setup puppet and use hiera. This tool is designed to match a certain kind of setup, including:
+
+- an [external node classifier (ENC)][enc]
+- a yaml hiera datastore
+- classes that only contains includes and no code
+- local availability of a hierafile
+
+As the development is going on, more generic options will be provided, but for now, we mainly make it robust to fit the context we have.
+
+
 Install
 -----------
-At this stage, it's to early to even think about installing anything. The internal code from Gandi is still in progress of transition towards total freedom.
+At this stage, it's to early to even think about installing anything. The internal code from Gandi is still in progress of transition towards total freedom and generic usage.
+
+Despite this warning, you can
+
+    gem install hieracles
+
+or add in your Gemfile:
+
+    gem 'hieracles'
+
+
+Configuration
+----------------
+At first launch it will create a configuration file in `~/.config/hieracles/config.yml`
+
+Configuration variables are:
+
+- classpath
+- modulepath
+- basepath
+- encpath
+- hierafile
+- format
+
+For an  example setup you can check in `spec/files`.
+
+Usage
+-------------
+
+
+    Usage: hc <fqdn> <command> [extra_args]
+
+    Available commands:
+      info        provides the farm, datacenter, country
+                  associated to the given fqdn
+      files       list all files containing params affecting this fqdn
+                  (in more than commons)
+      paths       list all file paths for files with params
+      modules     list modules included in the farm where the node is
+      params      list params for the node matching the fqdn
+                  An extra filter string can be added to limit the list
+                  use ruby regexp without the enclosing slashes
+                  eg. hc <fqdn> params postfix.*version
+                  eg. hc <fqdn> params '^postfix'
+                  eg. hc <fqdn> params 'version$'
+      allparams   same as params but including the common.yaml params (huge)
+                  Also accepts a search string
+
+    Extra args:
+      -f <plain|console|csv|yaml|rawyaml> default console
+      -p extraparam=what;anotherparam=this 
+      -c <configfile>
+      -h <hierafile>
+      -b <basepath> default ./
+      -e <encdir>
+
+Completion
+-------------
+There is a simple zsh completion file in `tools/completion`. 
+
+If you use [oh-my-zsh][omz] put it in `~/.oh-my-zsh/completions`
+
+    wget -O ~/.oh-my-zsh/completions/_hc https://raw.githubusercontent.com/Gandi/hieracles/master/tools/completion/_hc
+    echo 'compdef _hc hc "bundle exec hc"' >> ~/.zshrc
+
+Otherwise 
+
+    mkdir ~/.zsh-completions
+    wget -O ~/.zsh-completions/_hc https://raw.githubusercontent.com/Gandi/hieracles/master/tools/completion/_hc
+    echo 'fpath=(~/.zsh-completions $fpath)' >> ~/.zshrc
+    echo 'compdef _hc hc "bundle exec hc"' >> ~/.zshrc
 
 Authors
 -----------
@@ -28,3 +113,5 @@ copyright (c) 2015 Gandi http://gandi.net
 [puppet]:    https://github.com/puppetlabs/puppet
 [hiera]:     https://github.com/puppetlabs/hiera
 [gandi]:     https://gandi.net
+[enc]:       https://docs.puppetlabs.com/guides/external_nodes.html
+[omz]:       https://github.com/robbyrussell/oh-my-zsh

data/lib/hieracles/formats/rawyaml.rb

@@ -0,0 +1,36 @@
+module Hieracles
+  module Formats
+    # format mostly useful for re-integration in param files
+    class Rawyaml < Hieracles::Format
+
+      def info(_)
+        @node.info.to_yaml
+      end
+
+      def files(_)
+        @node.files.to_yaml
+      end
+
+      def paths(_)
+        @node.paths.to_yaml
+      end
+
+      def modules(_)
+        @node.modules.to_yaml
+      end
+
+      def params(args)
+        @node.params_tree(true).to_yaml
+      end
+
+      def allparams(args)
+        @node.params_tree(false).to_yaml
+      end
+
+      def modules(args)
+        @node.modules.to_yaml
+      end
+
+    end
+  end
+end

data/lib/hieracles/formats/yaml.rb

@@ -20,17 +20,50 @@ module Hieracles
       end
 
       def params(args)
-        @node.params_tree(true).to_yaml
+        commented_yaml_tree(true)
       end
 
       def allparams(args)
-        @node.params_tree(false).to_yaml
+        commented_yaml_tree(false)
       end
 
       def modules(args)
         @node.modules.to_yaml
       end
 
+
+      def commented_yaml_tree(without_common = true)
+        tree = @node.params_tree(without_common)
+        params = Hash[@node.params(without_common)]
+        mergetree('---', [], tree, params)
+      end
+
+      def mergetree(output, key, leaf, params)
+        indent = '  ' * key.count
+        case leaf.class.name
+        when 'Hash'
+          leaf.each do |k, v|
+            output += "\n" + indent + k + ': '
+            output = mergetree(output, key + [k], v, params)
+          end
+        when 'Array'
+          yaml = leaf.to_yaml[4..-1]
+          aryaml = yaml.each_line.map do |l|
+            indent + l
+          end
+          output += "\n" + indent + "# " + params[key.join('.')][0][:file]
+          output += "\n" + aryaml.join().chomp
+        when 'String'
+          output += leaf
+          if params["#{key.join('.')}"]
+            output += " # " + params[key.join('.')][0][:file]
+          else
+            raise "#{key}"
+          end
+        end
+        output
+      end
+
     end
   end
 end

data/lib/hieracles/help.rb

@@ -21,6 +21,14 @@ module Hieracles
                     eg. hc <fqdn> params 'version$'
         allparams   same as params but including the common.yaml params (huge)
                     Also accepts a search string
+
+      Extra args:
+        -f <plain|console|csv|yaml|rawyaml> default console
+        -p extraparam=what;anotherparam=this 
+        -c <configfile>
+        -h <hierafile>
+        -b <basepath> default ./
+        -e <encdir>
       END
     end
   end

data/lib/hieracles/node.rb

@@ -20,7 +20,7 @@ module Hieracles
     def get_hiera_params(fqdn)
       if File.exist?(File.join(Config.path('encpath'), "#{fqdn}.yaml"))
         load = YAML.load_file(File.join(Config.path('encpath'), "#{fqdn}.yaml"))
-        sym_keys(load['parameters'])
+        sym_keys(load['parameters']).merge({ classes: load['classes']})
       else
         raise "Node not found"
       end
@@ -66,25 +66,29 @@ module Hieracles
     end
 
     def modules
-     if File.exist?(classfile)
-        modules = {}
-        f = File.open(classfile, "r")
-        f.each_line do |line|
-          modules = add_modules(line, modules)
+      modules = {}
+      classfiles.each do |c|
+        if File.exist?(c)
+          f = File.open(c, "r")
+          f.each_line do |line|
+            modules = add_modules(line, modules)
+          end
+          f.close
+        else
+          raise "Class file #{c} not found."
         end
-        f.close
-        modules
-      else
-        raise "Class file #{classfile} not found."
       end
+      modules
     end
 
     def info
       @hiera_params
     end
 
-    def classfile
-      format(Config.path('classpath'), @hiera_params[:farm])
+    def classfiles
+      @hiera_params[:classes].map do |cl|
+        format(Config.path('classpath'), cl)
+      end
     end
 
     def modulepath(path)

data/lib/hieracles.rb

@@ -9,6 +9,7 @@ require 'hieracles/formats/csv'
 require 'hieracles/formats/yaml'
 require 'hieracles/formats/plain'
 require 'hieracles/formats/console'
+require 'hieracles/formats/rawyaml'
 
 # https://github.com/Gandi/hieracles
 module Hieracles

data/spec/files/enc/server.example.com.yaml

@@ -1,6 +1,6 @@
 ---                                                                                                                                              
 classes:
-  - test_class
+  - dev
 parameters:
   country: fr
   datacenter: equinix

data/spec/files/enc/server2.example.com.yaml

@@ -1,6 +1,6 @@
 ---                                                                                                                                              
 classes:
-  - test_class
+  - dev2
 parameters:
   country: fr
   datacenter: equinix

data/spec/files/enc/server3.example.com.yaml

@@ -1,6 +1,6 @@
 ---                                                                                                                                              
 classes:
-  - test_class
+  - dev3
 parameters:
   country: fr
   datacenter: equinix

data/spec/files/enc/server4.example.com.yaml

@@ -0,0 +1,8 @@
+---                                                                                                                                              
+classes:
+  - dev2
+  - dev4
+parameters:
+  country: fr
+  datacenter: equinix
+  farm: dev2

data/spec/files/farm_modules/dev4.pp

@@ -0,0 +1,4 @@
+class test_class {
+  include faux_module1
+  include faux_module2
+}

data/spec/files/modules/faux_module1/manifests/init.pp

@@ -0,0 +1,3 @@
+class faux_module1 {
+  
+}

data/spec/files/modules/faux_module2/manifests/init.pp

@@ -0,0 +1,3 @@
+class faux_module2 {
+  
+}

data/spec/lib/formats/rawyaml_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+describe Hieracles::Formats::Rawyaml do
+  let(:node) { double("node") }
+  let(:yaml_format) { Hieracles::Formats::Rawyaml.new node }
+
+  describe ".info" do
+    let(:expected) {"---\nNode: fqdn\nFarm: farm\n"}
+    before {
+      allow(node).to receive(:info).and_return(
+        {
+          'Node' => 'fqdn',
+          'Farm' => 'farm'
+        }
+      )
+    }
+    it "outputs proper text" do
+      expect(yaml_format.info nil).to eq expected
+    end
+  end
+
+  describe ".files" do
+    let(:expected) { "---\n- path1\n- path2\n" }
+    before {
+      allow(node).to receive(:files).and_return(['path1', 'path2'])
+    }
+    it "outputs proper text" do
+      expect(yaml_format.files nil).to eq expected
+    end
+  end
+
+  describe ".paths" do
+    let(:expected) { "---\n- path1\n- path2\n" }
+    before {
+      allow(node).to receive(:paths).and_return(['path1', 'path2'])
+    }
+    it "outputs proper text" do
+      expect(yaml_format.paths nil).to eq expected
+    end
+  end
+
+  describe ".modules" do
+    before {
+      allow(node).to receive(:modules).and_return(
+        { 
+          'module1' => "value", 
+          'longmodule2' => "not found"
+        }
+      )
+    }
+    let(:expected) { "---\nmodule1: value\nlongmodule2: not found\n" }
+    it "outputs proper text" do
+      expect(yaml_format.modules nil).to eq expected
+    end
+  end
+
+  describe ".params" do
+    let(:expected) { 
+       "---\n"+
+       "params:\n" +
+       "  this:\n" +
+       "    var: value1\n"
+    }
+    before {
+      allow(node).to receive(:params_tree).and_return(
+        { 
+          'params' => {
+            'this' => {
+              'var' => 'value1'
+            }
+          }
+        }
+      )
+    }
+    it "outputs proper text" do
+      expect(yaml_format.params nil).to eq expected
+    end
+  end
+end

data/spec/lib/formats/yaml_spec.rb

@@ -57,11 +57,19 @@ describe Hieracles::Formats::Yaml do
   describe ".params" do
     let(:expected) { 
        "---\n"+
-       "params:\n" +
-       "  this:\n" +
-       "    var: value1\n"
+       "params: \n" +
+       "  this: \n" +
+       "    var: value1 # some/file"
     }
     before {
+      allow(node).to receive(:params).and_return(
+        { 
+          'params.this.var' => [{
+            file: 'some/file',
+            value: 'value1'
+          }]
+        }
+      )
       allow(node).to receive(:params_tree).and_return(
         { 
           'params' => {
@@ -76,5 +84,143 @@ describe Hieracles::Formats::Yaml do
       expect(yaml_format.params nil).to eq expected
     end
   end
-  
+
+  describe '.mergetree' do
+    context "with a simple string key-value" do
+      let(:params) {
+        { 
+          'key' => [{
+            file: 'what/file',
+            value: 'value'
+          }]
+        }
+      }
+      let(:input) {
+        { 'key' => 'value' }
+      }
+      let(:expected) {
+        "\nkey: value # what/file"
+      }
+      it { expect(yaml_format.mergetree('', [], input, params)).to eq expected }
+    end
+    context "with a simple array key-value" do
+      let(:params) {
+        { 
+          'key' => [{
+            file: 'what/file',
+            value: ['value1', 'value2']
+          }]
+        }
+      }
+      let(:input) {
+        { 'key' => ['value1', 'value2'] }
+      }
+      let(:expected) {
+        "\nkey: \n  # what/file\n  - value1\n  - value2"
+      }
+      it { expect(yaml_format.mergetree('', [], input, params)).to eq expected }
+    end
+    context "with a 2-levels string key-value" do
+      let(:params) {
+        { 
+          'key.sublevel' => [{
+            file: 'what/file',
+            value: 'value'
+          }]
+        }
+      }
+      let(:input) {
+        { 
+          'key' => {
+            'sublevel' => 'value'
+          }
+        }
+      }
+      let(:expected) {
+        "\nkey: \n  sublevel: value # what/file"
+      }
+      it { expect(yaml_format.mergetree('', [], input, params)).to eq expected }
+    end
+    context "with 2 2-levels string key-value" do
+      let(:params) {
+        { 
+          'key.sublevel' => [{
+            file: 'what/file',
+            value: 'value'
+          }],
+          'key.sublevel2' => [{
+            file: 'what/file2',
+            value: 'value2'
+          }]
+        }
+      }
+      let(:input) {
+        { 
+          'key' => {
+            'sublevel' => 'value',
+            'sublevel2' => 'value2'
+          }
+        }
+      }
+      let(:expected) {
+        "\nkey: \n  sublevel: value # what/file\n  sublevel2: value2 # what/file2"
+      }
+      it { expect(yaml_format.mergetree('', [], input, params)).to eq expected }
+    end
+    context "with a 3-levels string key-value" do
+      let(:params) {
+        { 
+          'key.sublevel.subsublevel' => [{
+            file: 'what/file',
+            value: 'value'
+          }]
+        }
+      }
+      let(:input) {
+        { 
+          'key' => {
+            'sublevel' => {
+              'subsublevel' => 'value'
+            }
+          }
+        }
+      }
+      let(:expected) {
+        "\nkey: \n  sublevel: \n    subsublevel: value # what/file"
+      }
+      it { expect(yaml_format.mergetree('', [], input, params)).to eq expected }
+    end
+    context "with a 3-levels double string key-value" do
+      let(:params) {
+        { 
+          'key.sublevel.subsublevel' => [{
+            file: 'what/file',
+            value: 'value'
+          }],
+          'key2.sublevel' => [{
+            file: 'what/file2',
+            value: 'value'
+          }]
+        }
+      }
+      let(:input) {
+        { 
+          'key' => {
+            'sublevel' => {
+              'subsublevel' => 'value'
+            }
+          },
+          'key2' => {
+            'sublevel' => 'value'
+          }
+        }
+      }
+      let(:expected) {
+        "\nkey: \n  sublevel: \n    subsublevel: value # what/file" +
+        "\nkey2: \n  sublevel: value # what/file2"
+      }
+      it { expect(yaml_format.mergetree('', [], input, params)).to eq expected }
+    end
+  end
+
 end

data/spec/lib/node_spec.rb

@@ -18,6 +18,7 @@ describe Hieracles::Node do
       let(:node) { Hieracles::Node.new 'server.example.com', extraoptions }
       let(:expected) {
         { 
+          classes: ['dev'],
           fqdn: 'server.example.com',
           country: 'fr',
           datacenter: 'equinix',
@@ -42,6 +43,7 @@ describe Hieracles::Node do
     describe '.new' do
       let(:expected) {
         { 
+          classes: ['dev'],
           fqdn: 'server.example.com',
           country: 'fr',
           datacenter: 'equinix',
@@ -142,10 +144,24 @@ describe Hieracles::Node do
         let(:node) { Hieracles::Node.new 'server3.example.com', options }
         it { expect { node.modules }.to raise_error(RuntimeError) }
       end
+      context "multiple classes included" do
+        let(:node) { Hieracles::Node.new 'server4.example.com', options }
+        let(:expected) {
+          {
+            "fake_module" => "modules/fake_module",
+            "fake_module2" => "modules/fake_module2",
+            "fake_module4" => nil,
+            "faux_module1" => "modules/faux_module1",
+            "faux_module2" => "modules/faux_module2"
+          }
+        }
+        it { expect(node.modules).to eq expected }
+      end
     end
 
     describe '.info' do
       let(:expected) { {
+        classes: ['dev'],
         fqdn: 'server.example.com',
         datacenter: 'equinix',
         country: 'fr',
@@ -153,6 +169,7 @@ describe Hieracles::Node do
       } }
       it { expect(node.info).to eq expected }
     end
+
   end
 
 end

data/tools/completion/_hc

@@ -0,0 +1,13 @@
+#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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hieracles
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - mose
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-11 00:00:00.000000000 Z
+date: 2015-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -135,6 +135,7 @@ files:
 - 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
@@ -145,14 +146,18 @@ files:
 - 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
@@ -161,6 +166,7 @@ files:
 - 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
@@ -168,6 +174,7 @@ files:
 - spec/lib/optparse_spec.rb
 - spec/lib/utils_spec.rb
 - spec/spec_helper.rb
+- tools/completion/_hc
 homepage: https://github.com/Gandi/hieracles
 licenses:
 - MIT
@@ -189,7 +196,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.7
 signing_key: 
 specification_version: 4
 summary: CLI tool for Hiera parameters visualisation.
@@ -198,14 +205,18 @@ test_files:
 - 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
@@ -214,6 +225,7 @@ test_files:
 - 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