kafo_parsers 0.0.6 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fc259a5db6ee3563620d111d1775e2c85f4d6968
-  data.tar.gz: 656f94ca96aa36bbebf37c126083e18aa7a4e546
+  metadata.gz: 7317ced24d434141968dbe2d6a7587562c1315ee
+  data.tar.gz: fad877075b7f49f78959329081cb69649b20f1d3
 SHA512:
-  metadata.gz: 17c14657902bde419c774515ff6a43969cd9eea1d887320f1f66cc0b4df64bd0b4f65d53e39426c1c5e2f03b0f679249a4f1d3f2bf0a110852451a3750b95436
-  data.tar.gz: 30f393c3208da33b04dacceb0b8db24d71b2773365efcc4fb017da8ad26c6c8b2c8835fbbe1699af8414b45972ab33f23a7f56ca4c6db0766820bb652f0c3fed
+  metadata.gz: 7eef567e4e770c4d00a2f12ef2cc3a7bc71554d647695f9d286fc07f463798836d61572fb434c781bcff3a729f7244d10ee7ffd68389b25de1f7524aa3b27e50
+  data.tar.gz: 7df4289db02589fc951d7f421be6995fc97e788420d2de4878ef547d3f9816b398b8f3142fc99439c80d6ac3291b43c71e7653ea0ce02bd028805577e1ea1643

data/README.md

@@ -25,13 +25,51 @@ Or install it yourself as:
 
 ## Usage
 
-To parse file and see parsed information
+To parse file using the best available parser, and see parsed information:
+```ruby
+require 'kafo_parsers/parsers'
+parser = KafoParsers::Parsers.find_available or fail('No parser available')
+hash = parser.parse('/puppet/module/manifests/init.pp')
+p hash
+```
+
+`find_available` can take a logger object that responds to `#debug` to log
+detailed reasons why each parser isn't available.
+
+```ruby
+logger = Logging.logger(STDOUT)
+logger.level = :debug
+KafoParsers::Parsers.find_available(:logger => logger)
+```
+
+To load a specific parser:
 ```ruby
 require 'kafo_parsers/puppet_module_parser'
 hash = KafoParsers::PuppetModuleParser.parse('/puppet/module/manifests/init.pp')
-p hash
 ```
 
+#### PuppetModuleParser
+
+The standard PuppetModuleParser loads Puppet as a regular library or gem, so it
+must be installed in the same Ruby that's running kafo_parsers.
+
+Only Puppet versions 2.6.x, 2.7.x and 3.x are supported.
+
+Add `gem 'puppet', '< 4'` to your application's Gemfile to use this.
+
+#### PuppetStringsModuleParser
+
+If you use Puppet 4 you prefer PuppetStringsModuleParser which leverages
+puppet-strings to parse puppet manifests.
+
+```ruby
+require 'kafo_parsers/puppet_strings_module_parser'
+hash = KafoParsers::PuppetStringsModuleParser.parse('/puppet/module/manifests/init.pp')
+```
+
+Output will be similar to PuppetModuleParser, only validations are not supported,
+since they are not parsed by puppet-strings.
+
 # License
 
 This project is licensed under the GPLv3+.

data/lib/kafo_parsers/exceptions.rb

@@ -6,4 +6,20 @@ module KafoParsers
   class ModuleName < StandardError
   end
 
+  class ParserNotAvailable < StandardError
+    def initialize(wrapped)
+      if wrapped.is_a?(Exception)
+        @wrapped = wrapped
+      else
+        @message = wrapped
+      end
+    end
+
+    def message
+      @message || @wrapped.message
+    end
+  end
+  
+  class ParseError < StandardError
+  end
 end

data/lib/kafo_parsers/parsers.rb

@@ -0,0 +1,21 @@
+require 'kafo_parsers/puppet_module_parser.rb'
+require 'kafo_parsers/puppet_strings_module_parser.rb'
+
+module KafoParsers
+  module Parsers
+    def self.all
+      [ PuppetModuleParser, PuppetStringsModuleParser ]
+    end
+
+    def self.find_available(options = {})
+      all.find do |provider|
+        begin
+          provider.available?
+        rescue ParserNotAvailable => e
+          options[:logger].debug "Provider #{provider} not available: #{e.message}" if options[:logger]
+          false
+        end
+      end
+    end
+  end
+end

data/lib/kafo_parsers/puppet_module_parser.rb

@@ -1,5 +1,4 @@
 # encoding: UTF-8
-require 'puppet'
 require 'kafo_parsers/doc_parser'
 
 module KafoParsers
@@ -10,6 +9,13 @@ module KafoParsers
   class PuppetModuleParser
     @@puppet_initialized = false
 
+    def self.available?
+      require 'puppet'
+      [2, 3].include?(Puppet::PUPPETVERSION.to_i)
+    rescue LoadError => e
+      raise KafoParsers::ParserNotAvailable.new(e)
+    end
+
     # You can call this method to get all supported information from a given manifest
     #
     # @param [ String ] manifest file path to parse
@@ -32,11 +38,13 @@ module KafoParsers
       raise KafoParsers::ModuleName, "File not found #{file}, check your answer file" unless File.exists?(file)
 
       unless @@puppet_initialized
+        require 'puppet'
         if Puppet::PUPPETVERSION.to_i >= 3
           Puppet.initialize_settings
         else
           Puppet.parse_config
         end
+        Encoding.default_external = Encoding::UTF_8 if defined?(Encoding) && Encoding.respond_to?(:default_external=)
         @@puppet_initialized = true
       end
 

data/lib/kafo_parsers/puppet_strings_module_parser.rb

@@ -0,0 +1,126 @@
+# encoding: UTF-8
+require 'json'
+require 'kafo_parsers/doc_parser'
+
+module KafoParsers
+  class PuppetStringsModuleParser
+    # You can call this method to get all supported information from a given manifest
+    #
+    # @param [ String ] manifest file path to parse
+    # @return [ Hash ] hash containing values, validations, documentation, types, groups and conditions
+    def self.parse(file)
+      content = new(file)
+      docs    = content.docs
+
+      # data_type must be called before other validations
+      data = {
+        :object_type => content.data_type,
+        :values      => content.values,
+        :validations => content.validations
+      }
+      data[:parameters] = data[:values].keys
+      data.merge!(docs)
+      data
+    end
+
+    def self.available?
+      `#{puppet_bin} help strings`
+      if $?.success?
+        return true
+      else
+        raise KafoParsers::ParserNotAvailable.new("#{puppet_bin} does not have strings module installed")
+      end
+    end
+
+    def initialize(file)
+      @file = file
+      raise KafoParsers::ModuleName, "File not found #{file}, check your answer file" unless File.exists?(file)
+
+      command = "#{self.class.puppet_bin} strings #{file} --emit-json-stdout"
+      @raw_json = `#{command}`
+      unless $?.success?
+        raise KafoParsers::ParseError, "'#{command}' returned error\n#{@raw_json}"
+      end
+
+      begin
+        @complete_hash = ::JSON.parse(@raw_json)
+      rescue ::JSON::ParserError => e
+        raise KafoParsers::ParseError, "'#{command}' returned invalid json output: #{e.message}\n#{@raw_json}"
+      end
+      self.data_type # we need to determine data_type before any further parsing
+
+      self
+    end
+
+    # AIO and system default puppet bins are tested for existence, fallback to just `puppet` otherwise
+    def self.puppet_bin
+      @puppet_bin ||= begin
+        found_puppet_path = (::ENV['PATH'].split(File::PATH_SEPARATOR) + ['/opt/puppetlabs/bin']).find do |path|
+          binary = File.join(path, 'puppet')
+          binary if File.executable?(binary)
+        end
+        File.join(found_puppet_path, 'puppet') || 'puppet'
+      end
+    end
+
+    def data_type
+      @data_type ||= begin
+        if (@parsed_hash = @complete_hash['puppet_classes'].find { |klass| klass['file'] == @file })
+          'hostclass'
+        elsif (@parsed_hash = @complete_hash['defined_types'].find { |klass| klass['file'] == @file })
+          'definition'
+        else
+          raise KafoParsers::ParseError, "unable to find manifest data, syntax error in manifest #{@file}?"
+        end
+      end
+    end
+
+    def values
+      Hash[@parsed_hash['parameters'].map { |name, value| [ name, sanitize(value) ] }]
+    end
+
+    # unsupported in puppet strings parser
+    def validations(param = nil)
+      []
+    end
+
+    # returns data in following form
+    # {
+    #   :docs => { $param1 => 'documentation without types and conditions'}
+    #   :types => { $param1 => 'boolean'},
+    #   :groups => { $param1 => ['Parameters', 'Advanced']},
+    #   :conditions => { $param1 => '$db_type == "mysql"'},
+    # }
+    def docs
+      data = { :docs => {}, :types => {}, :groups => {}, :conditions => {} }
+      if @parsed_hash.nil?
+        raise KafoParsers::DocParseError, "no documentation found for manifest #{@file}, parsing error?"
+      elsif !@parsed_hash['docstring'].nil?
+        parser             = DocParser.new(@parsed_hash['docstring']).parse
+        data[:docs]        = parser.docs
+        data[:groups]      = parser.groups
+        data[:types]       = parser.types
+        data[:conditions]  = parser.conditions
+      end
+      data
+    end
+
+    private
+
+    # default values using puppet strings includes $ symbol, e.g. "$::foreman::params::ssl"
+    # to keep the same API we strip $ if it's present
+    #
+    # values are reported as strings which is issue especially for :under
+    # strings are double quoted
+    # others must be typecast manually according to reported type
+    def sanitize(value)
+      if (value.start_with?("'") && value.end_with?("'")) || (value.start_with?('"') && value.end_with?('"'))
+        value = value[1..-2]
+      end
+      value = value[1..-1] if value.start_with?('$')
+      value = :undef if value == 'undef'
+
+      value
+    end
+  end
+end

data/lib/kafo_parsers/version.rb

@@ -1,3 +1,3 @@
 module KafoParsers
-  VERSION = "0.0.6"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kafo_parsers
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.0
 platform: ruby
 authors:
 - Marek Hulan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-11 00:00:00.000000000 Z
+date: 2016-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,16 +28,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '11'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: 4.0.0
-  type: :runtime
+        version: 5.0.0
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.9.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: This gem can parse values, validations, documentation, types, groups
   and conditions of parameters from your puppet modules
 email:
@@ -122,7 +136,9 @@ files:
 - lib/kafo_parsers.rb
 - lib/kafo_parsers/doc_parser.rb
 - lib/kafo_parsers/exceptions.rb
+- lib/kafo_parsers/parsers.rb
 - lib/kafo_parsers/puppet_module_parser.rb
+- lib/kafo_parsers/puppet_strings_module_parser.rb
 - lib/kafo_parsers/version.rb
 homepage: https://github.com/theforeman/kafo_parsers
 licenses:
@@ -149,3 +165,4 @@ signing_key:
 specification_version: 4
 summary: Puppet module parsers
 test_files: []
+has_rdoc: