kafo_parsers 0.1.6 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0a6477915864cbf2a6ec73458c997e3665cb70d6
-  data.tar.gz: 5556804196ff59db1f71c01f490544c90f6b92f5
+SHA256:
+  metadata.gz: f510d851fccf71e96f9fd835195990a4e669fd5722592f1673823a4a651eeb77
+  data.tar.gz: e98e7f725fd65d900371fef825db343b25fedd70ac9aee21edaeeaef25ca7d98
 SHA512:
-  metadata.gz: 1e1f5e24969c68aa7769e9969cd337d45292520780db95e97e4f11dd280bb1b6846d146829b1e0e51480fa103b9608241d2915466493a9e91ed0f971ab5e96e7
-  data.tar.gz: a447adc8b3af98f7fb4430b11ba659ddd6ba0518c139d652b27fe2e1a16f05dbe06f0ad0e0902dabae46653b84da25bf01b36887a0df26a7b6671e6b7227d616
+  metadata.gz: cdbe4e4c5ebab2e4e41f29209c4b84f8c595e7585f0deb1d8f94ae2c90519810874b76458a96acf98255de9721c3502cbbd97390829180caa125bcda0673778b
+  data.tar.gz: da851240e0bde3e0fe253b9c3e9e6953fb83e21eea8c15740f28df6065192b0d446c4dcc7825d0d8204ebcdfb4368c69238e0d978a3cf598d10115e21fd5485e

data/README.md

@@ -44,34 +44,21 @@ 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')
+require 'kafo_parsers/puppet_strings_module_parser'
+hash = KafoParsers::PuppetStringsModuleParser.parse('/puppet/module/manifests/init.pp')
 ```
 
-#### 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. This requires puppet-strings 0.99 or
-higher and may be installed either as a gem in the same environment, or in a
-Puppet AIO installation.
+Leverage puppet-strings to parse puppet manifests. This requires puppet-strings
+1.2.0 or higher and may be installed either as a gem in the same environment,
+or in a Puppet AIO installation.
 
 ```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.
-
 ## Documentation syntax
 
 ### RDoc syntax
@@ -110,7 +97,6 @@ Supports:
 
 Used by:
 
-* `PuppetModuleParser`
 * `PuppetStringsModuleParser` (but deprecated, prefer YARD)
 
 ### YARD syntax

data/lib/kafo_parsers/parsers.rb

@@ -1,10 +1,9 @@
-require 'kafo_parsers/puppet_module_parser.rb'
 require 'kafo_parsers/puppet_strings_module_parser.rb'
 
 module KafoParsers
   module Parsers
     def self.all
-      [ PuppetModuleParser, PuppetStringsModuleParser ]
+      [ PuppetStringsModuleParser ]
     end
 
     def self.find_available(options = {})

data/lib/kafo_parsers/puppet_strings_module_parser.rb

@@ -1,5 +1,7 @@
 # encoding: UTF-8
 require 'json'
+require 'open3'
+
 require 'kafo_parsers/doc_parser'
 require 'kafo_parsers/param_doc_parser'
 
@@ -25,25 +27,25 @@ module KafoParsers
     end
 
     def self.available?
-      `#{puppet_bin} help strings 2>&1`
-      if $?.success?
+      _stdout, _stderr, status = run_puppet(['help', 'strings'])
+      if status.success?
         return true
       else
-        raise KafoParsers::ParserNotAvailable.new("#{puppet_bin} does not have strings module installed")
+        raise KafoParsers::ParserNotAvailable.new("#{puppet_bin} does not have strings module installed.")
       end
     end
 
     def initialize(file)
       @file = file = File.expand_path(file)
-      raise KafoParsers::ModuleName, "File not found #{file}, check your answer file" unless File.exists?(file)
+      raise KafoParsers::ModuleName, "File not found #{file}, check your answer file" unless File.exist?(file)
+
+      command = ['strings', 'generate', '--format', 'json', file]
+      @raw_json, stderr, status = self.class.run_puppet(command)
 
-      command = "#{self.class.puppet_bin} strings generate --emit-json-stdout #{file}"
-      @raw_json = `#{command}`
-      unless $?.success?
-        raise KafoParsers::ParseError, "'#{command}' returned error\n#{@raw_json}"
+      unless status.success?
+        raise KafoParsers::ParseError, "'#{command}' returned error:\n  #{@raw_json}\n  #{stderr}"
       end
 
-      Encoding.default_external = Encoding::UTF_8 if defined?(Encoding)
       begin
         @complete_hash = ::JSON.parse(@raw_json)
       rescue ::JSON::ParserError => e
@@ -131,6 +133,42 @@ module KafoParsers
 
     private
 
+    def self.search_puppet_path(bin_name)
+      # Find the location of the puppet executable and use that to
+      # determine the path of all executables
+      bin_path = (::ENV['PATH'].split(File::PATH_SEPARATOR) + ['/opt/puppetlabs/bin']).find do |path|
+        File.executable?(File.join(path, 'puppet')) && File.executable?(File.join(path, bin_name))
+      end
+      File.join([bin_path, bin_name].compact)
+    end
+
+    def self.is_aio_puppet?
+      puppet_command = search_puppet_path('puppet')
+      File.realpath(puppet_command).start_with?('/opt/puppetlabs')
+    rescue Errno::ENOENT
+      false
+    end
+
+    def self.run_puppet(command)
+      command = command.unshift(self.puppet_bin)
+
+      if is_aio_puppet?
+        Open3.capture3(clean_env_vars, *command, :unsetenv_others => true)
+      else
+        Open3.capture3(::ENV, *command, :unsetenv_others => false)
+      end
+    end
+
+    def self.clean_env_vars
+      # Cleaning ENV vars and keeping required vars only because,
+      # When using SCL it adds GEM_HOME and GEM_PATH ENV vars.
+      whitelisted_vars = %w[HOME USER LANG]
+
+      cleaned_env = ::ENV.select { |var| whitelisted_vars.include?(var) || var.start_with?('LC_') }
+      cleaned_env['PATH'] = '/sbin:/bin:/usr/sbin:/usr/bin:/opt/puppetlabs/bin'
+      cleaned_env
+    end
+
     # default values using puppet strings includes $ symbol, e.g. "$::foreman::params::ssl"
     #
     # values are reported as strings which is issue especially for :under

data/lib/kafo_parsers/version.rb

@@ -1,3 +1,3 @@
 module KafoParsers
-  VERSION = "0.1.6"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kafo_parsers
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 1.2.0
 platform: ruby
 authors:
 - Marek Hulan
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-01-05 00:00:00.000000000 Z
+date: 2021-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,58 +28,58 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '11'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '11'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: ci_reporter
+  name: ci_reporter_minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.9.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.9.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -124,15 +124,13 @@ files:
 - lib/kafo_parsers/exceptions.rb
 - lib/kafo_parsers/param_doc_parser.rb
 - lib/kafo_parsers/parsers.rb
-- lib/kafo_parsers/puppet_module_parser.rb
 - lib/kafo_parsers/puppet_strings_module_parser.rb
-- lib/kafo_parsers/validation.rb
 - lib/kafo_parsers/version.rb
 homepage: https://github.com/theforeman/kafo_parsers
 licenses:
-- GPLv3+
+- GPL-3.0+
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -147,9 +145,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Puppet module parsers
 test_files: []

data/lib/kafo_parsers/puppet_module_parser.rb

@@ -1,138 +0,0 @@
-# encoding: UTF-8
-require 'kafo_parsers/doc_parser'
-require 'kafo_parsers/validation'
-
-module KafoParsers
-  # Based on ideas from puppet-parse by Johan van den Dorpe
-  # we don't build any tree structure since e.g. params from doc does not
-  # have to be defined in puppet DSL and vice versa, we just gather all info
-  # we can read from the whole manifest
-  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
-    # @return [ Hash ] hash containing values, validations, documentation, types, groups and conditions
-    def self.parse(file)
-      content = new(file)
-      docs    = content.docs
-
-      data              = {
-          :values      => content.values,
-          :validations => content.validations
-      }
-      data[:parameters] = data[:values].keys
-      data.merge!(docs)
-      data
-    end
-
-    def initialize(file)
-      called_before_each_test = false
-
-      @file = file = File.expand_path(file)
-      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
-          require 'puppet/test/test_helper'
-          if Puppet::Test::TestHelper.respond_to?(:initialize) # 3.1+
-            Puppet::Test::TestHelper.initialize
-          end
-          Puppet::Test::TestHelper.before_all_tests
-        else
-          Puppet.parse_config
-        end
-        Encoding.default_external = Encoding::UTF_8 if defined?(Encoding)
-        @@puppet_initialized = true
-      end
-
-      if Puppet::PUPPETVERSION.to_i >= 3
-        Puppet::Test::TestHelper.before_each_test
-        called_before_each_test = true
-      end
-
-      env = Puppet::Node::Environment.new
-      parser = Puppet::Parser::Parser.new(env)
-      parser.import(@file)
-
-      # Find object corresponding to class defined in init.pp in list of hostclasses
-      ast_types = parser.environment.known_resource_types.hostclasses.map(&:last)
-      @object = ast_types.find { |ast_type| ast_type.file == file }
-
-      # Find object in list of definitions if not found among hostclasses
-      if @object.nil?
-        ast_types = parser.environment.known_resource_types.definitions.map(&:last)
-        @object = ast_types.find { |ast_type| ast_type.file == file }
-      end
-
-      parser
-    ensure
-      Puppet::Test::TestHelper.after_each_test if called_before_each_test
-    end
-
-    # TODO - store parsed object type (Puppet::Parser::AST::Variable must be dumped later)
-    def values
-      parameters = {}
-      arguments  = @object.respond_to?(:arguments) ? @object.arguments : {}
-      arguments.each { |k, v| parameters[k] = interpret_ast([v])[0] }
-      parameters
-    end
-
-    def validations(param = nil)
-      return [] if @object.code.nil?
-      @object.code.select { |stmt| stmt.is_a?(Puppet::Parser::AST::Function) && stmt.name =~ /^validate_/ }.map do |v|
-        Validation.new(v.name, interpret_ast(v.arguments))
-      end
-    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"'},
-    #   :object_type => 'hostclass' # or definition
-    # }
-    def docs
-      data = { :docs => {}, :types => {}, :groups => {}, :conditions => {}, :object_type => '' }
-      if @object.nil?
-        raise KafoParsers::DocParseError, "no documentation found for manifest #{@file}, parsing error?"
-      elsif !@object.doc.nil?
-        parser             = DocParser.new(@object.doc).parse
-        data[:docs]        = parser.docs
-        data[:groups]      = parser.groups
-        data[:types]       = Hash.new('string').merge(parser.types)
-        data[:conditions]  = parser.conditions
-        data[:object_type] = @object.type.to_s
-      end
-      data
-    end
-
-    private
-
-    def interpret_ast(args)
-      args.map do |arg|
-        if arg.is_a?(Puppet::Parser::AST::Variable)
-          arg.to_s
-        elsif arg.is_a?(Puppet::Parser::AST::ASTArray)
-          interpret_ast(arg.to_a)
-        elsif arg.is_a?(Puppet::Parser::AST::Concat)
-          interpret_ast(arg.value).join
-        elsif arg.respond_to? :value
-          arg.value
-        else
-          arg
-        end
-      end
-    end
-  end
-end

data/lib/kafo_parsers/validation.rb

@@ -1,14 +0,0 @@
-module KafoParsers
-  class Validation
-    attr_reader :name, :arguments
-
-    def initialize(name, arguments)
-      @name = name
-      @arguments = arguments
-    end
-
-    def ==(other)
-      name == other.name && arguments == other.arguments
-    end
-  end
-end