chef-powershell 1.0.7 → 2.18.5

data/chef-powershell.gemspec

@@ -1,52 +1,52 @@
-# frozen_string_literal: true
-lib = File.expand_path("lib", __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-bin = File.expand_path("bin", __dir__)
-$LOAD_PATH.unshift(bin) unless $LOAD_PATH.include?(bin)
-require "chef-powershell/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "chef-powershell"
-  spec.version       = ChefPowerShell::VERSION
-  spec.authors       = ["Chef Software, Inc"]
-  spec.email         = ["oss@chef.io"]
-
-  spec.summary       = %q{External Chef module for accessing and utilizing PowerShell}
-  spec.homepage      = "https://github.com/chef/chef-powershell-shim"
-  spec.license       = "Apache-2.0"
-
-  spec.required_ruby_version = ">= 2.6"
-
-  spec.add_runtime_dependency "ffi", "~> 1.15"
-  spec.add_runtime_dependency "ffi-yajl", "~> 2.4"
-
-  spec.metadata = {
-    "bug_tracker_uri" => "https://github.com/chef/chef/issues",
-    "changelog_uri" => "https://github.com/chef/chef-powershell-shim/CHANGELOG.md",
-    "documentation_uri" => "https://github.com/chef/chef-powershell-shim/chef-powershell/README.md",
-    "homepage_uri" => "https://github.com/chef/chef/tree/main/chef-powershell",
-    "source_code_uri" => "https://github.com/chef/chef-powershell-shim/chef-powershell",
-  }
-
-  spec.require_paths = %w{lib bin}
-
-  #
-  # NOTE: DO NOT ADD RUNTIME DEPS TO OTHER CHEF ECOSYSTEM GEMS
-  # (e.g. chef, ohai, mixlib-anything, ffi-yajl, and IN PARTICULAR NOT chef-config)
-  #
-  # This is so that this set of common code can be reused in any other library without
-  # creating circular dependencies.  If you find yourself wanting to do that you probably
-  # have a helper that should go into the library you want to declare a dependency on,
-  # or you need to create another gem that is not this one.  You may also want to rub some
-  # dependency injection on your API to invert things so that you don't have to take
-  # a dependency on the thing you need (i.e. allow injecting a hash-like thing instead of taking
-  # a dep on mixlib-config and then require the consumer to wire up chef-config to your
-  # API).  Same for mixlib-log and Chef::Log in general.
-  #
-  # ABSOLUTELY NO EXCEPTIONS
-  #
-  spec.bindir        = "bin"
-  spec.executables   = []
-  spec.files = %w{Rakefile LICENSE} + Dir.glob("*.gemspec") +
-    Dir.glob("{lib,spec,bin}/**/*", File::FNM_DOTMATCH).reject { |f| File.directory?(f) }
-end
+# frozen_string_literal: true
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+bin = File.expand_path("bin", __dir__)
+$LOAD_PATH.unshift(bin) unless $LOAD_PATH.include?(bin)
+require "chef-powershell/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "chef-powershell"
+  spec.version       = ChefPowerShellModule::VERSION
+  spec.authors       = ["Chef Software, Inc"]
+  spec.email         = ["oss@chef.io"]
+
+  spec.summary       = %q{External Chef module for accessing and utilizing PowerShell}
+  spec.homepage      = "https://github.com/chef/chef-powershell-shim"
+  spec.license       = "Apache-2.0"
+
+  spec.required_ruby_version = ">= 2.6"
+
+  spec.add_runtime_dependency "ffi", "~> 1.15"
+  spec.add_runtime_dependency "ffi-yajl", "~> 2.4"
+
+  spec.metadata = {
+    "bug_tracker_uri" => "https://github.com/chef/chef/issues",
+    "changelog_uri" => "https://github.com/chef/chef-powershell-shim/CHANGELOG.md",
+    "documentation_uri" => "https://github.com/chef/chef-powershell-shim/chef-powershell/README.md",
+    "homepage_uri" => "https://github.com/chef/chef/tree/main/chef-powershell",
+    "source_code_uri" => "https://github.com/chef/chef-powershell-shim/chef-powershell",
+  }
+
+  spec.require_paths = %w{lib bin}
+
+  #
+  # NOTE: DO NOT ADD RUNTIME DEPS TO OTHER CHEF ECOSYSTEM GEMS
+  # (e.g. chef, ohai, mixlib-anything, ffi-yajl, and IN PARTICULAR NOT chef-config)
+  #
+  # This is so that this set of common code can be reused in any other library without
+  # creating circular dependencies.  If you find yourself wanting to do that you probably
+  # have a helper that should go into the library you want to declare a dependency on,
+  # or you need to create another gem that is not this one.  You may also want to rub some
+  # dependency injection on your API to invert things so that you don't have to take
+  # a dependency on the thing you need (i.e. allow injecting a hash-like thing instead of taking
+  # a dep on mixlib-config and then require the consumer to wire up chef-config to your
+  # API).  Same for mixlib-log and Chef::Log in general.
+  #
+  # ABSOLUTELY NO EXCEPTIONS
+  #
+  spec.bindir        = "bin"
+  spec.executables   = []
+  spec.files = %w{Rakefile LICENSE} + Dir.glob("*.gemspec") +
+    Dir.glob("{lib,spec,bin}/**/*", File::FNM_DOTMATCH).reject { |f| File.directory?(f) }
+end

data/lib/chef-powershell/exceptions.rb

@@ -15,7 +15,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-class Chef_PowerShell
+class ChefPowerShell
   class PowerShellExceptions
     class PowerShellCommandFailed < RuntimeError; end
 

data/lib/chef-powershell/powershell.rb

@@ -16,12 +16,11 @@
 # limitations under the License.
 
 require "ffi" unless defined?(FFI)
-require_relative "json_compat"
+autoload :FFI_Yajl, "ffi_yajl"
 require_relative "exceptions"
 require_relative "unicode"
-# require "chef-powershell"
 
-class Chef_PowerShell
+class ChefPowerShell
   class PowerShell
 
     attr_reader :result
@@ -58,18 +57,47 @@ class Chef_PowerShell
     end
 
     #
-    # @raise [Chef_PowerShell::PowerShellExceptions::PowerShellCommandFailed] raise if the command failed
+    # @raise [ChefPowerShell::PowerShellExceptions::PowerShellCommandFailed] raise if the command failed
     #
     def error!
-      raise Chef_PowerShell::PowerShellExceptions::PowerShellCommandFailed, "Unexpected exit in PowerShell command: #{@errors}" if error?
+      raise ChefPowerShell::PowerShellExceptions::PowerShellCommandFailed, "Unexpected exit in PowerShell command: #{@errors}" if error?
     end
 
     module PowerMod
+      class << self
+        attr_accessor :result_string, :retry_count, :exception, :result, :errors, :verbose, :hashed_outcome
+      end
+
       extend FFI::Library
+      # FFI requires attaching to modules, not classes, so we need to
+      # have a module here. The module level variables *could* be refactored
+      # out here, but still 100% of the work still goes through the module.
       @@powershell_dll = Gem.loaded_specs["chef-powershell"].full_gem_path + "/bin/ruby_bin_folder/#{ENV["PROCESSOR_ARCHITECTURE"]}/Chef.PowerShell.Wrapper.dll"
       @@ps_command = ""
       @@ps_timeout = -1
 
+      StoreResultCallback = FFI::Function.new(:bool, [:pointer, :size_t]) do |data, size|
+        # try parsing the result *first* before returning from the function, and if it fails,
+        # return false so that the function can be retried from the C++ side.
+        begin
+          #          @@result_string = data.get_bytes(0, size).force_encoding("UTF-16LE").encode("UTF-8")
+          @result_string = data.get_bytes(0, size).force_encoding("UTF-16LE").encode("UTF-8").bytes.reverse.drop_while {|x| x == 0}.reverse.pack("C*")
+          @hashed_outcome = FFI_Yajl::Parser.parse(@result_string)
+          @result = FFI_Yajl::Parser.parse(@hashed_outcome["result"])
+          @errors = @hashed_outcome["errors"]
+          @verbose = @hashed_outcome["verbose"]
+          true
+        rescue => e
+          @retry_count += 1
+          puts "#{e.inspect}"
+          @exception = e
+          return true if @retry_count > 3
+          puts "Retrying PowerShell command execution #{@retry_count}"
+          sleep 1
+          false
+        end
+      end
+
       def self.set_ps_dll(value)
         @@powershell_dll = value
       end
@@ -83,9 +111,12 @@ class Chef_PowerShell
       end
 
       def self.do_work
+        @exception = nil
+        @retry_count = 0
         ffi_lib @@powershell_dll
-        attach_function :execute_powershell, :ExecuteScript, %i{string int}, :pointer
-        execute_powershell(@@ps_command, @@ps_timeout)
+        attach_function :execute_powershell, :ExecuteScript, %i{string int pointer}, :pointer
+
+        execute_powershell(@@ps_command, @@ps_timeout, StoreResultCallback)
       end
     end
 
@@ -93,15 +124,18 @@ class Chef_PowerShell
 
     def exec(script, timeout: -1)
       timeout = -1 if timeout == 0 || timeout.nil?
+
+      # Set it every time because the test suite actually switches
+      # the DLL pointed to.
       PowerMod.set_ps_dll(@powershell_dll)
       PowerMod.set_ps_timeout(timeout)
+
       PowerMod.set_ps_command(script)
       execution = PowerMod.do_work
-      output = execution.read_utf16string
-      hashed_outcome = Chef::JSONCompat.parse(output)
-      @result = Chef::JSONCompat.parse(hashed_outcome["result"])
-      @errors = hashed_outcome["errors"]
-      @verbose = hashed_outcome["verbose"]
+      raise PowerMod.exception if PowerMod.exception
+      @result = PowerMod.result
+      @errors = PowerMod.errors
+      @verbose = PowerMod.verbose
     end
   end
 end

data/lib/chef-powershell/powershell_exec.rb

@@ -23,7 +23,7 @@ require_relative "./pwsh"
 # powershell_exec is initialized with a string that should be set to the script
 # to run and also takes an optional interpreter argument which must be either
 # :powershell (Windows PowerShell which is the default) or :pwsh (PowerShell
-# Core). It will return a Chef_PowerShell::PowerShell object that provides 5 methods:
+# Core). It will return a ChefPowerShell::PowerShell object that provides 5 methods:
 #
 # .result - returns a hash representing the results returned by executing the
 #           PowerShell script block
@@ -95,8 +95,8 @@ require_relative "./pwsh"
 #   credentials of the user running Chef Client are used.
 #
 
-class Chef_PowerShell
-  module ChefPowerShell
+class ChefPowerShell
+  module ChefPowerShellModule
     module PowerShellExec
       # The Chef.PowerShell.Wrapper.dll file looks in the same folder as ruby.exe OR in the folder specified by the environment variable CHEF_POWERSHELL_BIN for other chef powershell dll's
       # We don't want to move files around so we're setting the variable here to keep everything tidy.
@@ -113,16 +113,16 @@ class Chef_PowerShell
       def powershell_exec(script, interpreter = :powershell, timeout: -1)
         case interpreter
         when :powershell
-          Chef_PowerShell::PowerShell.new(script, timeout: timeout)
+          ChefPowerShell::PowerShell.new(script, timeout: timeout)
         when :pwsh
-          Chef_PowerShell::Pwsh.new(script, timeout: timeout)
+          ChefPowerShell::Pwsh.new(script, timeout: timeout)
         else
           raise ArgumentError, "Expected interpreter of :powershell or :pwsh"
         end
       end
 
       # The same as the #powershell_exec method except this will raise
-      # Chef_PowerShell::PowerShellExceptions::PowerShellCommandFailed if the command fails
+      # ChefPowerShell::PowerShellExceptions::PowerShellCommandFailed if the command fails
       def powershell_exec!(script, interpreter = :powershell, **options)
         cmd = powershell_exec(script, interpreter, **options)
         cmd.error!

data/lib/chef-powershell/pwsh.rb

@@ -15,8 +15,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-class Chef_PowerShell
-  class Pwsh < Chef_PowerShell::PowerShell
+class ChefPowerShell
+  class Pwsh < ChefPowerShell::PowerShell
     # Run a command under pwsh (powershell core) via FFI
     # This implementation requires the managed dll, native wrapper and a
     # published, self contained dotnet core directory tree to exist in the

data/lib/chef-powershell/version.rb

@@ -1,20 +1,20 @@
-# frozen_string_literal: true
-# Copyright:: Copyright (c) Chef Software Inc.
-# License:: Apache License, Version 2.0
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-module ChefPowerShell
-  CHEFPOWERSHELL_ROOT = File.expand_path("..", __dir__)
-  VERSION = "1.0.7"
-end
+# frozen_string_literal: true
+# Copyright:: Copyright (c) Chef Software Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module ChefPowerShellModule
+  CHEFPOWERSHELL_ROOT = File.expand_path("..", __dir__)
+  VERSION = "2.18.5".freeze
+end

data/lib/chef-powershell.rb

@@ -18,6 +18,6 @@
 
 require_relative "chef-powershell/powershell_exec"
 
-module ChefPowerShell
-  include Chef_PowerShell::ChefPowerShell::PowerShellExec
+module ChefPowerShellModule
+  include ChefPowerShell::ChefPowerShellModule::PowerShellExec
 end

data/spec/unit/powershell_exec_spec.rb

@@ -18,8 +18,8 @@
 
 require "chef-powershell"
 
-describe Chef_PowerShell::ChefPowerShell::PowerShellExec, :windows_only do
-  let(:powershell_mixin) { Class.new { include Chef_PowerShell::ChefPowerShell::PowerShellExec } }
+describe ChefPowerShell::ChefPowerShellModule::PowerShellExec, :windows_only do
+  let(:powershell_mixin) { Class.new { include ChefPowerShell::ChefPowerShellModule::PowerShellExec } }
   subject(:object) { powershell_mixin.new }
 
   before do
@@ -30,7 +30,7 @@ describe Chef_PowerShell::ChefPowerShell::PowerShellExec, :windows_only do
   describe "#powershell_exec" do
     context "not specifying an interpreter" do
       it "runs a basic command and returns a Chef::PowerShell object" do
-        expect(object.powershell_exec("$PSVersionTable", :powershell, timeout: -1)).to be_kind_of(Chef_PowerShell::PowerShell)
+        expect(object.powershell_exec("$PSVersionTable", :powershell, timeout: -1)).to be_kind_of(ChefPowerShell::PowerShell)
       end
 
       it "uses less than version 7" do
@@ -41,7 +41,7 @@ describe Chef_PowerShell::ChefPowerShell::PowerShellExec, :windows_only do
 
     context "using pwsh interpreter" do
       it "runs a basic command and returns a Chef::PowerShell object" do
-        expect(object.powershell_exec("$PSVersionTable", :pwsh, timeout: -1)).to be_kind_of(Chef_PowerShell::Pwsh)
+        expect(object.powershell_exec("$PSVersionTable", :pwsh, timeout: -1)).to be_kind_of(ChefPowerShell::Pwsh)
       end
 
       it "uses greater than version 6" do
@@ -52,7 +52,7 @@ describe Chef_PowerShell::ChefPowerShell::PowerShellExec, :windows_only do
 
     context "using powershell interpreter" do
       it "runs a basic command and returns a Chef::PowerShell object" do
-        expect(object.powershell_exec("$PSVersionTable", :powershell, timeout: -1)).to be_kind_of(Chef_PowerShell::PowerShell)
+        expect(object.powershell_exec("$PSVersionTable", :powershell, timeout: -1)).to be_kind_of(ChefPowerShell::PowerShell)
       end
 
       it "uses less than version 6" do
@@ -80,11 +80,11 @@ describe Chef_PowerShell::ChefPowerShell::PowerShellExec, :windows_only do
 
   describe "#powershell_exec!" do
     it "runs a basic command and returns a Chef::PowerShell object" do
-      expect(object.powershell_exec!("$PSVersionTable", :powershell, timeout: -1)).to be_kind_of(Chef_PowerShell::PowerShell)
+      expect(object.powershell_exec!("$PSVersionTable", :powershell, timeout: -1)).to be_kind_of(ChefPowerShell::PowerShell)
     end
 
     it "raises an error if the command fails" do
-      expect { object.powershell_exec!("this-should-error") }.to raise_error(Chef_PowerShell::PowerShellExceptions::PowerShellCommandFailed)
+      expect { object.powershell_exec!("this-should-error") }.to raise_error(ChefPowerShell::PowerShellExceptions::PowerShellCommandFailed)
     end
 
     it "raises an error if the interpreter is invalid" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chef-powershell
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 2.18.5
 platform: ruby
 authors:
 - Chef Software, Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-07 00:00:00.000000000 Z
+date: 2023-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -329,7 +329,7 @@ files:
 - bin/ruby_bin_folder/AMD64/shared/Microsoft.NETCore.App/5.0.0/mi.dll
 - bin/ruby_bin_folder/AMD64/shared/Microsoft.NETCore.App/5.0.0/miutils.dll
 - bin/ruby_bin_folder/AMD64/shared/Microsoft.NETCore.App/5.0.0/mscordaccore.dll
-- bin/ruby_bin_folder/AMD64/shared/Microsoft.NETCore.App/5.0.0/mscordaccore_amd64_amd64_5.0.521.16609.dll
+- bin/ruby_bin_folder/AMD64/shared/Microsoft.NETCore.App/5.0.0/mscordaccore_amd64_amd64_5.0.1522.11506.dll
 - bin/ruby_bin_folder/AMD64/shared/Microsoft.NETCore.App/5.0.0/mscordbi.dll
 - bin/ruby_bin_folder/AMD64/shared/Microsoft.NETCore.App/5.0.0/mscorlib.dll
 - bin/ruby_bin_folder/AMD64/shared/Microsoft.NETCore.App/5.0.0/mscorrc.dll
@@ -658,7 +658,6 @@ files:
 - chef-powershell.gemspec
 - lib/chef-powershell.rb
 - lib/chef-powershell/exceptions.rb
-- lib/chef-powershell/json_compat.rb
 - lib/chef-powershell/powershell.rb
 - lib/chef-powershell/powershell_exec.rb
 - lib/chef-powershell/pwsh.rb
@@ -691,7 +690,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: External Chef module for accessing and utilizing PowerShell

data/lib/chef-powershell/json_compat.rb

@@ -1,63 +0,0 @@
-#
-# Author:: Tim Hinderliter (<tim@chef.io>)
-# Copyright:: Copyright (c) Chef Software Inc.
-# License:: Apache License, Version 2.0
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# Wrapper class for interacting with JSON.
-
-autoload :FFI_Yajl, "ffi_yajl"
-require_relative "exceptions"
-# We're requiring this to prevent breaking consumers using Hash.to_json
-require "json" unless defined?(JSON)
-
-class Chef
-  class JSONCompat
-
-    class << self
-
-      def parse(source, opts = {})
-        FFI_Yajl::Parser.parse(source, opts)
-      rescue FFI_Yajl::ParseError => e
-        raise Chef_PowerShell::PowerShellExceptions::JSON::ParseError, e.message
-      end
-
-      def from_json(source, opts = {})
-        obj = parse(source, opts)
-
-        # JSON gem requires top level object to be a Hash or Array (otherwise
-        # you get the "must contain two octets" error). Yajl doesn't impose the
-        # same limitation. For compatibility, we re-impose this condition.
-        unless obj.is_a?(Hash) || obj.is_a?(Array)
-          raise Chef_PowerShell::PowerShellExceptions::JSON::ParseError, "Top level JSON object must be a Hash or Array. (actual: #{obj.class})"
-        end
-
-        obj
-      end
-
-      def to_json(obj, opts = nil)
-        FFI_Yajl::Encoder.encode(obj, opts)
-      rescue FFI_Yajl::EncodeError => e
-        raise Chef_PowerShell::PowerShellExceptions::JSON::EncodeError, e.message
-      end
-
-      def to_json_pretty(obj, opts = nil)
-        options_map = { pretty: true }
-        options_map[:indent] = opts[:indent] if opts.respond_to?(:key?) && opts.key?(:indent)
-        to_json(obj, options_map).chomp
-      end
-
-    end
-  end
-end