hieracles 0.0.1

checksums.yaml

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

data/.coveralls.yml

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

data/.gitignore

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

data/.rspec

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

data/.ruby-version

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

data/.travis.yml

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

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+Hieracles Changelog
+=======================
+
+### 0.0.1 - 2015-09-12
+- first alpha release
+- added extensive testing using rspec
+- add more config variables and parameters for fitting various environments
+- initial transition to Github from internal v0.0.5 Gandi code.

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2015 gandi.net 
+
+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,30 @@
+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)
+[![Code Climate](https://img.shields.io/codeclimate/github/Gandi/hieracles.svg)](https://codeclimate.com/github/Gandi/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.
+
+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.
+
+Authors
+-----------
+Hieracles original code is writen by [@mose](https://github.com/mose).
+
+License
+-----------
+Hieracles is available under MIT license. See [LICENSE](./LICENSE) file for more details
+
+Copyright
+------------
+copyright (c) 2015 Gandi http://gandi.net
+
+
+[puppet]:    https://github.com/puppetlabs/puppet
+[hiera]:     https://github.com/puppetlabs/hiera
+[gandi]:     https://gandi.net

data/Rakefile

@@ -0,0 +1,14 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+require 'rspec/core/rake_task'
+
+desc 'launch rspec tests'
+task :spec do
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.rspec_opts = ['-c', '-f Fivemat', '-r ./spec/spec_helper.rb']
+    t.pattern = 'spec/lib/**/*_spec.rb'
+  end
+end
+
+task default: :spec

data/bin/hc

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH << File.expand_path("../../lib", __FILE__)
+
+require 'hieracles'
+
+opt = Hieracles::Optparse.new(ARGV)
+
+fqdn = opt.payload[0]
+command = opt.payload[1]
+args = opt.payload[2..-1]
+
+unless fqdn && command
+  puts Hieracles::Help.usage
+  exit(1)
+end
+ 
+if Hieracles::Format.method_defined? command
+  node = Hieracles::Node.new fqdn, opt.options
+  begin
+    formatter = Object.const_get("Hieracles::Formats::#{Hieracles::Config.format}")
+  rescue
+    puts "  Unknown format #{Hieracles::Config.format}"
+    exit(1)
+  end
+  dispatch = formatter.new node
+  puts dispatch.send(command.to_sym, args)
+else
+  puts "  Unknown command: #{command}"
+  Hieracles::Help.usage
+  exit(1)
+end

data/bin/nodeinfo

@@ -0,0 +1,41 @@
+#!/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

data/hieracles.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "hieracles"
+  spec.version       = File.read(File.expand_path('../CHANGELOG.md', __FILE__))[/([0-9]+\.[0-9]+\.[0-9]+)/]
+  spec.authors       = ["mose"]
+  spec.email         = ["mose@gandi.net"]
+  spec.summary       = %q{CLI tool for Hiera parameters visualisation.}
+  spec.description   = %q{CLI tool for Hiera parameters visualisation and analysis.}
+  spec.homepage      = "https://github.com/Gandi/hieracles"
+  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.executables   = ['hc']
+  spec.test_files    = spec.files.grep(%r{^spec/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'rspec', "~> 3.0"
+  spec.add_development_dependency 'fivemat'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'rubocop'
+
+end

data/lib/hieracles.rb

@@ -0,0 +1,15 @@
+require 'hieracles/optparse'
+require 'hieracles/config'
+require 'hieracles/hiera'
+require 'hieracles/utils'
+require 'hieracles/help'
+require 'hieracles/node'
+require 'hieracles/format'
+require 'hieracles/formats/csv'
+require 'hieracles/formats/yaml'
+require 'hieracles/formats/plain'
+require 'hieracles/formats/console'
+
+# https://github.com/Gandi/hieracles
+module Hieracles
+end

data/lib/hieracles/config.rb

@@ -0,0 +1,56 @@
+require 'fileutils'
+
+module Hieracles
+  # configuration singleton
+  module Config
+    extend self
+
+    attr_reader :extraparams, :server, :classpath, 
+      :modulepath, :hierafile, :basepath, :encpath, :format
+
+    def load(options)
+      @optionfile = options[:config] || defaultconfig
+      @extraparams = extract_params(options[:params])
+      initconfig(@optionfile) unless File.exist? @optionfile
+      values = YAML.load_file(@optionfile)
+      @server = values['server']
+      @classpath = values['classpath']
+      @modulepath = values['modulepath'] || 'modules'
+      @encpath = options[:encpath] || values['encpath'] || 'enc'
+      @basepath = File.expand_path(options[:basepath] || values['basepath'] || '.')
+      @hierafile = options[:hierafile] || values['hierafile'] || 'hiera.yaml'
+      @format = (options[:format] || values['format'] || 'console').capitalize
+    end
+
+    def initconfig(file)
+      FileUtils.mkdir_p(File.dirname(file))
+      File.open(file, 'w') do |f|
+        f.puts '---'
+        f.puts '# uncomment if you use the CGI method for discovery'
+        f.puts '# server: puppetserver.example.com'
+        f.puts 'classpath: manifests/classes/%s.pp'
+        f.puts 'modulepath: modules'
+        f.puts 'encpath: enc'
+        f.puts 'hierafile: hiera.yaml'
+      end
+    end
+
+    def defaultconfig
+      File.join(ENV['HOME'], '.config', 'hieracles', 'config.yml')
+    end
+
+    # str is like: something=xxx;another=yyy  
+    def extract_params(str)
+      return {} unless str
+      str.split(';').reduce({}) do |a, k|
+        a["#{k[/^[^=]*/]}".to_sym] = k[/[^=]*$/]
+        a
+      end
+    end
+
+    def path(what)
+      File.join(@basepath, send(what.to_sym))
+    end
+
+  end
+end

data/lib/hieracles/format.rb

@@ -0,0 +1,58 @@
+module Hieracles
+  class Format
+    def initialize(node)
+      @node = node
+    end
+
+    def info(_)
+      "#{__callee__} not implemented, please inherit from the Hieracles::Format class to implement a format.\n"
+    end
+
+    def files(_)
+      "#{__callee__} not implemented, please inherit from the Hieracles::Format class to implement a format.\n"
+    end
+
+    def paths(_)
+      "#{__callee__} not implemented, please inherit from the Hieracles::Format class to implement a format.\n"
+    end
+
+    def params(args)
+      show_params(true, args)
+    end
+
+    def allparams(args)
+      show_params(false, args)
+    end
+
+    def show_params(without_common, args)
+      filter = args[0]
+      output = build_head(without_common)
+      @node.params(without_common).each do |k, v|
+        output << build_params_line(k, v, filter)
+      end
+      output
+    end
+
+    def modules(args)
+      output = ''
+      @node.modules.each do |k, v|
+        output << build_modules_line(k, v)
+      end
+      output
+    end
+
+  protected
+
+    def build_head(without_common)
+      "#{__callee__} not implemented, please inherit from the Hieracles::Format class to implement a format.\n"
+    end
+
+    def build_params_line(key, value, filter)
+      "#{__callee__} not implemented, please inherit from the Hieracles::Format class to implement a format.\n"
+    end
+
+    def build_modules_line(key, value)
+      "#{__callee__} not implemented, please inherit from the Hieracles::Format class to implement a format.\n"
+    end
+  end
+end

data/lib/hieracles/formats/console.rb

@@ -0,0 +1,84 @@
+module Hieracles
+  module Formats
+    # format accepting colors
+    # for display in the terminal
+    class Console < Hieracles::Format
+      include Hieracles::Utils
+
+      COLORS = [
+        "\e[31m%s\e[0m",
+        "\e[32m%s\e[0m",
+        "\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[97m%s\e[0m"
+      ]
+
+      def initialize(node)
+        @colors = {}
+        super(node)
+      end
+
+      def info(_)
+        back = ''
+        length = max_key_length(@node.info) + 2
+        title = format(COLORS[8], "%-#{length}s")
+        @node.info.each do |k, v|
+          back << format("#{title} %s\n", k, v)
+        end
+        back
+      end
+
+      def files(_)
+        @node.files.join("\n") + "\n"
+      end
+
+      def paths(_)
+        @node.paths.join("\n") + "\n"
+      end
+
+      def build_head(without_common)
+        output = ''
+        @node.files(without_common).each_with_index do |f, i|
+          output << format("#{COLORS[i]}\n", "[#{i}] #{f}")
+          @colors[f] = i
+        end
+        "#{output}\n"
+      end
+
+      def build_params_line(key, value, filter)
+        output = ''
+        if !filter || Regexp.new(filter).match(key)
+          first = value.shift
+          filecolor_index = @colors[first[:file]]
+          filecolor = COLORS[filecolor_index]
+          output << format("#{filecolor} #{COLORS[5]} %s\n",
+                           "[#{filecolor_index}]",
+                            key,
+                            first[:value].to_s.gsub('%', '%%')
+                          )
+          while value.count > 0
+            overriden = value.shift
+            filecolor_index = @colors[overriden[:file]]
+            output << format("    #{COLORS[8]}\n",
+                             "[#{filecolor_index}] #{key} #{overriden[:value]}"
+                            )
+          end
+        end
+        output
+      end
+
+      def build_modules_line(key, value)
+        length = max_key_length(@node.modules) + 3
+        value_color = '%s'
+        value_color = COLORS[0] if /not found/i.match value
+        value_color = COLORS[2] if /\(duplicate\)/i.match value
+        format("%-#{length}s #{value_color}\n", key, value)
+      end
+
+    end
+  end
+end