pdk 1.14.0 → 1.14.1

data/lib/pdk/module/build.rb

@@ -1,3 +1,5 @@
+require 'pdk'
+
 module PDK
   module Module
     class Build

data/lib/pdk/module/convert.rb

@@ -1,3 +1,5 @@
+require 'pdk'
+
 module PDK
   module Module
     class Convert

data/lib/pdk/module/metadata.rb

@@ -1,4 +1,4 @@
-require 'pdk/util/filesystem'
+require 'pdk'
 
 module PDK
   module Module
@@ -108,6 +108,7 @@ module PDK
           raise ArgumentError, _('Invalid JSON in metadata.json: %{msg}') % { msg: e.message }
         end
 
+        require 'pdk/util'
         data['template-url'] = PDK::Util::TemplateURI.default_template_uri.metadata_format if PDK::Util.package_install? && data['template-url'] == PDK::Util::TemplateURI::PACKAGED_TEMPLATE_KEYWORD
         new(data)
       end

data/lib/pdk/module/templatedir.rb

@@ -1,3 +1,5 @@
+require 'pdk'
+
 module PDK
   module Module
     class TemplateDir

data/lib/pdk/module/update.rb

@@ -1,4 +1,4 @@
-require 'pdk/module/convert'
+require 'pdk'
 
 module PDK
   module Module

data/lib/pdk/module/update_manager.rb

@@ -1,3 +1,5 @@
+require 'pdk'
+
 module PDK
   module Module
     class UpdateManager

data/lib/pdk/report.rb

@@ -1,7 +1,9 @@
-require 'pdk/report/event'
+require 'pdk'
 
 module PDK
   class Report
+    autoload :Event, 'pdk/report/event'
+
     # @return [Array<String>] the list of supported report formats.
     def self.formats
       @report_formats ||= %w[junit text].freeze

data/lib/pdk/report/event.rb

@@ -1,3 +1,5 @@
+require 'pdk'
+
 module PDK
   class Report
     class Event

data/lib/pdk/template_file.rb

@@ -1,4 +1,5 @@
 require 'ostruct'
+require 'pdk'
 
 module PDK
   class TemplateFile < OpenStruct

data/lib/pdk/tests/unit.rb

@@ -1,3 +1,5 @@
+require 'pdk'
+
 module PDK
   module Test
     class Unit
@@ -38,9 +40,7 @@ module PDK
 
         command = PDK::CLI::Exec::InteractiveCommand.new(*cmd_with_args(task)).tap do |c|
           c.context = :module
-          c.environment = environment.reject do |key, _|
-            key == 'CI_SPEC_OPTIONS'
-          end
+          c.environment = environment
         end
 
         command.execute!
@@ -95,6 +95,11 @@ module PDK
         spinner_msg = options[:parallel] ? _('Running unit tests in parallel.') : _('Running unit tests.')
 
         if options[:interactive]
+          environment['CI_SPEC_OPTIONS'] = if options[:verbose]
+                                             '--format documentation'
+                                           else
+                                             '--format progress'
+                                           end
           result = interactive_rake(cmd(tests, options), environment)
           return result[:exit_code]
         end

data/lib/pdk/util.rb

@@ -1,13 +1,30 @@
+require 'pdk'
+
 # PDK::Util::Windows can not be lazy loaded because it conditionally requires
 # other files on Windows only. This can probably be fixed up with a later
 # refactoring.
 require 'pdk/util/windows'
 
+autoload :Pathname, 'pathname'
+
 module PDK
   module Util
+    autoload :Bundler, 'pdk/util/bundler'
+    autoload :Env, 'pdk/util/env'
+    autoload :Filesystem, 'pdk/util/filesystem'
+    autoload :Git, 'pdk/util/git'
+    autoload :PuppetStrings, 'pdk/util/puppet_strings'
+    autoload :PuppetVersion, 'pdk/util/puppet_version'
+    autoload :RubyVersion, 'pdk/util/ruby_version'
+    autoload :TemplateURI, 'pdk/util/template_uri'
+    autoload :VendoredFile, 'pdk/util/vendored_file'
+    autoload :Version, 'pdk/util/version'
+
     MODULE_FOLDERS = %w[
       manifests
-      lib
+      lib/puppet
+      lib/puppet_x
+      lib/facter
       tasks
       facts.d
       functions
@@ -102,7 +119,7 @@ module PDK
     # @return [String] Fully qualified path to per-user PDK cachedir.
     def cachedir
       if Gem.win_platform?
-        File.join(ENV['LOCALAPPDATA'], 'PDK', 'cache')
+        File.join(PDK::Util::Env['LOCALAPPDATA'], 'PDK', 'cache')
       else
         File.join(Dir.home, '.pdk', 'cache')
       end
@@ -111,9 +128,9 @@ module PDK
 
     def configdir
       if Gem.win_platform?
-        File.join(ENV['LOCALAPPDATA'], 'PDK')
+        File.join(PDK::Util::Env['LOCALAPPDATA'], 'PDK')
       else
-        File.join(ENV.fetch('XDG_CONFIG_HOME', File.join(Dir.home, '.config')), 'pdk')
+        File.join(PDK::Util::Env.fetch('XDG_CONFIG_HOME', File.join(Dir.home, '.config')), 'pdk')
       end
     end
     module_function :configdir
@@ -143,12 +160,13 @@ module PDK
     module_function :module_fixtures_dir
 
     # Returns true or false depending on if any of the common directories in a module
-    # are found in the current directory
+    # are found in the specified directory. If a directory is not specified, the current
+    # working directory is used.
     #
     # @return [boolean] True if any folders from MODULE_FOLDERS are found in the current dir,
     #   false otherwise.
-    def in_module_root?
-      PDK::Util::MODULE_FOLDERS.any? { |dir| File.directory?(dir) }
+    def in_module_root?(path = Dir.pwd)
+      PDK::Util::MODULE_FOLDERS.any? { |dir| PDK::Util::Filesystem.directory?(File.join(path, dir)) }
     end
     module_function :in_module_root?
 

data/lib/pdk/util/bundler.rb

@@ -1,3 +1,5 @@
+require 'pdk'
+
 module PDK
   module Util
     module Bundler

data/lib/pdk/util/env.rb

@@ -0,0 +1,30 @@
+require 'pdk'
+require 'forwardable'
+
+module PDK
+  module Util
+    class Env
+      class << self
+        extend Forwardable
+
+        def_delegators :env_hash, :[], :key?, :fetch, :select, :reject
+
+        def []=(key, value)
+          if Gem.win_platform?
+            PDK::Util::Windows::Process.set_environment_variable(key, value)
+          else
+            ENV[key] = value
+          end
+        end
+
+        def env_hash
+          if Gem.win_platform?
+            PDK::Util::Windows::Process.environment_hash
+          else
+            ENV
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pdk/util/filesystem.rb

@@ -1,8 +1,11 @@
+require 'pdk'
+
 module PDK
   module Util
     module Filesystem
       def write_file(path, content)
-        raise ArgumentError unless path.is_a?(String) || path.respond_to?(:to_path)
+        raise ArgumentError, _('content must be a String') unless content.is_a?(String)
+        raise ArgumentError, _('path must be a String or Pathname') unless path.is_a?(String) || path.respond_to?(:to_path)
 
         # Harmonize newlines across platforms.
         content = content.encode(universal_newline: true)

data/lib/pdk/util/git.rb

@@ -1,3 +1,5 @@
+require 'pdk'
+
 module PDK
   module Util
     class GitError < StandardError
@@ -108,7 +110,7 @@ module PDK
           }
         end
 
-        matching_refs = output[:stdout].split("\n").map { |r| r.split("\t") }
+        matching_refs = output[:stdout].split(%r{\r?\n}).map { |r| r.split("\t") }
         matching_ref = matching_refs.find { |_sha, remote_ref| remote_ref == "refs/tags/#{ref}" || remote_ref == "refs/remotes/origin/#{ref}" || remote_ref == "refs/heads/#{ref}" }
         raise PDK::CLI::ExitWithError, _('Unable to find a branch or tag named "%{ref}" in %{repo}') % { ref: ref, repo: repo } if matching_ref.nil?
         matching_ref.first

data/lib/pdk/util/puppet_strings.rb

@@ -1,3 +1,5 @@
+require 'pdk'
+
 module PDK
   module Util
     module PuppetStrings
@@ -89,7 +91,7 @@ module PDK
       def self.all_objects
         require 'pdk/generate'
 
-        generators = PDK::Generate::GENERATORS.select do |gen|
+        generators = PDK::Generate.generators.select do |gen|
           gen.respond_to?(:puppet_strings_type) && !gen.puppet_strings_type.nil?
         end
 
@@ -114,7 +116,7 @@ module PDK
       def self.find_generator(type)
         require 'pdk/generate'
 
-        PDK::Generate::GENERATORS.find do |gen|
+        PDK::Generate.generators.find do |gen|
           gen.respond_to?(:puppet_strings_type) && gen.puppet_strings_type == type
         end
       end

data/lib/pdk/util/puppet_version.rb

@@ -1,3 +1,5 @@
+require 'pdk'
+
 module PDK
   module Util
     class PuppetVersion
@@ -42,7 +44,13 @@ module PDK
         latest
       end
 
-      def fetch_puppet_dev
+      def puppet_dev_fetched?
+        !@puppet_dev_fetched.nil?
+      end
+
+      def fetch_puppet_dev(options = {})
+        return if options[:run] == :once && puppet_dev_fetched?
+
         require 'pdk/util/git'
         require 'fileutils'
 
@@ -74,6 +82,8 @@ module PDK
 
         # Reset local repo to latest
         reset_result = PDK::Util::Git.git('-C', puppet_dev_path, 'reset', '--hard', 'origin/master')
+
+        @puppet_dev_fetched = true
         return if reset_result[:exit_code].zero?
 
         PDK.logger.error reset_result[:stdout]

data/lib/pdk/util/ruby_version.rb

@@ -1,3 +1,4 @@
+require 'pdk'
 require 'forwardable'
 
 module PDK

data/lib/pdk/util/template_uri.rb

@@ -1,3 +1,5 @@
+require 'pdk'
+
 module PDK
   module Util
     class TemplateURI

data/lib/pdk/util/vendored_file.rb

@@ -1,3 +1,5 @@
+require 'pdk'
+
 module PDK
   module Util
     class VendoredFile

data/lib/pdk/util/version.rb

@@ -1,3 +1,5 @@
+require 'pdk'
+
 module PDK
   module Util
     module Version

data/lib/pdk/util/windows.rb

@@ -8,6 +8,7 @@ module PDK
         require 'pdk/util/windows/api_types'
         require 'pdk/util/windows/string'
         require 'pdk/util/windows/file'
+        require 'pdk/util/windows/process'
       end
     end
   end

data/lib/pdk/util/windows/api_types.rb

@@ -2,6 +2,13 @@ require 'ffi'
 require 'pdk/util/windows/string'
 
 module PDK::Util::Windows::APITypes
+  module ::FFI::Library
+    def attach_function_private(*args)
+      attach_function(*args)
+      private args[0]
+    end
+  end
+
   class ::FFI::Pointer
     def self.from_string_to_wide_string(str, &_block)
       str = PDK::Util::Windows::String.wide_string(str)
@@ -28,6 +35,26 @@ module PDK::Util::Windows::APITypes
       }
       raise
     end
+
+    def read_arbitrary_wide_string_up_to(max_char_length = 512, null_terminator = :single_null, encode_options = {})
+      unless [:single_null, :double_null].include?(null_terminator)
+        raise ArgumentError, _(
+          'Unable to read wide strings with %{null_terminator} terminal nulls',
+        ) % { null_terminator: null_terminator }
+      end
+
+      terminator_width = (null_terminator == :single_null) ? 1 : 2
+      reader_method = (null_terminator == :single_null) ? :get_uint16 : :get_uint32
+
+      # Look for the null_terminator; if found, read up to that null
+      # (exclusive)
+      (0...max_char_length - terminator_width).each do |i|
+        return read_wide_string(i, Encoding::UTF_8, encode_options) if send(reader_method, (i * 2)).zero?
+      end
+
+      # String is longer than the max, read just up to the max
+      read_wide_string(max_char_length, Encoding::UTF_8, encode_options)
+    end
   end
 
   # FFI Types
@@ -47,4 +74,9 @@ module PDK::Util::Windows::APITypes
   # 8 bits per byte
   FFI.typedef :uchar, :byte
   FFI.typedef :uint16, :wchar
+
+  # FFI bool can be only 1 byte at times,
+  # Win32 BOOL is a signed int, and is always 4 bytes, even on x64
+  # https://blogs.msdn.com/b/oldnewthing/archive/2011/03/28/10146459.aspx
+  FFI.typedef :int32, :win32_bool
 end

data/lib/pdk/util/windows/process.rb

@@ -0,0 +1,79 @@
+require 'pdk/util/windows'
+
+module PDK::Util::Windows::Process
+  require 'ffi'
+  extend PDK::Util::Windows::String
+  extend FFI::Library
+
+  def environment_hash
+    env_ptr = GetEnvironmentStringsW()
+
+    contains_unicode_replacement = ->(string) do
+      return false unless string.include?("\uFFFD")
+
+      PDK.logger.warning _(
+        'Discarding environment variable %{string} which contains invalid ' \
+        'bytes',
+      ) % { string: string }
+      true
+    end
+
+    # pass :invalid => :replace to the Ruby String#encode to use replacement
+    # characters
+    pairs = env_ptr.read_arbitrary_wide_string_up_to(65_534, :double_null, invalid: :replace)
+                   .split(?\x00)
+                   .reject { |env_str| env_str.nil? || env_str.empty? || env_str[0] == '=' }
+                   .reject { |env_str| contains_unicode_replacement.call(env_str) }
+                   .map { |env_pair| env_pair.split('=', 2) }
+    Hash[pairs]
+  ensure
+    if env_ptr && !env_ptr.null?
+      if FreeEnvironmentStringsW(env_ptr) == PDK::Util::Windows::WIN32_FALSE
+        PDK.logger.debug _('FreeEnvironmentStringsW memory leak')
+      end
+    end
+  end
+  module_function :environment_hash
+
+  def set_environment_variable(name, val)
+    raise ArgumentError, _('Environment variable name must not be nil or empty') if name.nil? || name.empty?
+
+    FFI::MemoryPointer.from_string_to_wide_string(name) do |name_ptr|
+      if val.nil?
+        if SetEnvironmentVariableW(name_ptr, FFI::MemoryPointer::NULL) == PDK::Util::Windows::WIN32_FALSE
+          raise _('Failed to remove environment variable: %{name}') % { name: name }
+        end
+      else
+        FFI::MemoryPointer.from_string_to_wide_string(val) do |val_ptr|
+          if SetEnvironmentVariableW(name_ptr, val_ptr) == PDK::Util::Windows::WIN32_FALSE
+            raise _('Failed to set environment variaible: %{name}') % { name: name }
+          end
+        end
+      end
+    end
+  end
+  module_function :set_environment_variable
+
+  ffi_convention :stdcall
+
+  # https://msdn.microsoft.com/en-us/library/windows/desktop/ms683187(v=vs.85).aspx
+  # LPTCH GetEnvironmentStrings(void);
+  ffi_lib :kernel32
+  attach_function_private :GetEnvironmentStringsW, [], :pointer
+
+  # https://msdn.microsoft.com/en-us/library/windows/desktop/ms683151(v=vs.85).aspx
+  # BOOL FreeEnvironmentStrings(
+  #   _In_ LPTCH lpszEnvironmentBlock
+  # );
+  ffi_lib :kernel32
+  attach_function_private :FreeEnvironmentStringsW, [:pointer], :win32_bool
+
+  # https://msdn.microsoft.com/en-us/library/windows/desktop/ms686206(v=vs.85).aspx
+  # BOOL WINAPI SetEnvironmentVariableW(
+  #   _In_     LPCTSTR lpName,
+  #   _In_opt_ LPCTSTR lpValue
+  # );
+  ffi_lib :kernel32
+  attach_function_private :SetEnvironmentVariableW, [:lpcwstr, :lpcwstr],
+                          :win32_bool
+end