chef-powershell 1.0.0 → 1.0.13

data/lib/chef-powershell/exceptions.rb

@@ -1,27 +1,27 @@
-#
-# Author:: John McCrae (<john.mccrae@progress.com>)
-# 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.
-
-class Chef_PowerShell
-  class PowerShellExceptions
-    class PowerShellCommandFailed < RuntimeError; end
-
-    class JSON
-      class EncodeError < RuntimeError; end
-      class ParseError < RuntimeError; end
-    end
-  end
+#
+# Author:: John McCrae (<john.mccrae@progress.com>)
+# 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.
+
+class ChefPowerShell
+  class PowerShellExceptions
+    class PowerShellCommandFailed < RuntimeError; end
+
+    class JSON
+      class EncodeError < RuntimeError; end
+      class ParseError < RuntimeError; end
+    end
+  end
 end

data/lib/chef-powershell/powershell.rb

@@ -16,14 +16,12 @@
 # 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
-    extend FFI::Library
 
     attr_reader :result
     attr_reader :errors
@@ -36,16 +34,15 @@ class Chef_PowerShell
     # Requires: .NET Framework 4.0 or higher on the target machine.
     #
     # @param script [String] script to run
+    # @param timeout [Integer, nil] timeout in seconds.
     # @return [Object] output
-    def initialize(script)
+    def initialize(script, timeout: -1)
       # This Powershell DLL source lives here: https://github.com/chef/chef-powershell-shim
-      # Every merge into that repo triggers a Habitat build and promotion. Running
-      # the rake :update_chef_exec_dll task in this (chef/chef) repo will pull down
-      # the built packages and copy the binaries to chef-powershell/bin/ruby_bin_folder. Bundle install
-      # ensures that the correct architecture binaries are installed into the path.
-      powershell_dll = Gem.loaded_specs["chef-powershell"].full_gem_path + "/bin/ruby_bin_folder/#{ENV["PROCESSOR_ARCHITECTURE"]}/Chef.PowerShell.Wrapper.dll"
-      @dll ||= powershell_dll
-      exec(script)
+      # Every merge into that repo triggers a Habitat build and verification process.
+      # There is no mechanism to build a Windows gem file. It has to be done manually running manual_gem_release.ps1
+      # Bundle install ensures that the correct architecture binaries are installed into the path.
+      @powershell_dll = Gem.loaded_specs["chef-powershell"].full_gem_path + "/bin/ruby_bin_folder/#{ENV["PROCESSOR_ARCHITECTURE"]}/Chef.PowerShell.Wrapper.dll"
+      exec(script, timeout: timeout)
     end
 
     #
@@ -60,25 +57,48 @@ class Chef_PowerShell
     end
 
     #
-    # @raise [Chef::ChefPowerShell::CommandFailed] 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
 
-    # protected
-    private
+    module PowerMod
+      extend FFI::Library
+      @@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
+
+      def self.set_ps_dll(value)
+        @@powershell_dll = value
+      end
+
+      def self.set_ps_command(value)
+        @@ps_command = value
+      end
 
-    def self.attach(dll, script)
-      ffi_lib dll
-      attach_function :execute_powershell, :ExecuteScript, [:string], :pointer
+      def self.set_ps_timeout(value)
+        @@ps_timeout = value
+      end
+
+      def self.do_work
+        ffi_lib @@powershell_dll
+        attach_function :execute_powershell, :ExecuteScript, %i{string int}, :pointer
+        execute_powershell(@@ps_command, @@ps_timeout)
+      end
     end
 
-    def exec(script)
-      self.class.attach(@dll, script)
-      execution = execute_powershell(script).read_utf16string
-      hashed_outcome = Chef::JSONCompat.parse(execution)
-      @result = Chef::JSONCompat.parse(hashed_outcome["result"])
+    private
+
+    def exec(script, timeout: -1)
+      timeout = -1 if timeout == 0 || timeout.nil?
+      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 = FFI_Yajl::Parser.parse(output)
+      @result = FFI_Yajl::Parser.parse(hashed_outcome["result"])
       @errors = hashed_outcome["errors"]
       @verbose = hashed_outcome["verbose"]
     end

data/lib/chef-powershell/powershell_exec.rb

@@ -18,12 +18,12 @@
 require_relative "./powershell"
 require_relative "./pwsh"
 
-# The powershell_exec mixin provides in-process access to the PowerShell engine.
+# The Chef-PowerShell gem provides in-process access to the PowerShell engine.
 #
 # 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 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,9 +95,9 @@ require_relative "./pwsh"
 #   credentials of the user running Chef Client are used.
 #
 
-class Chef_PowerShell
-  module ChefPowerShell
-    module PowershellExec
+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.
       file_path = Gem.loaded_specs["chef-powershell"].full_gem_path + "/bin/ruby_bin_folder/#{ENV["PROCESSOR_ARCHITECTURE"]}/"
@@ -108,22 +108,23 @@ class Chef_PowerShell
       #
       # @param script [String] script to run
       # @param interpreter [Symbol] the interpreter type, `:powershell` or `:pwsh`
+      # @param timeout [Integer, nil] timeout in seconds.
       # @return [Chef::PowerShell] output
-      def powershell_exec(script, interpreter = :powershell)
+      def powershell_exec(script, interpreter = :powershell, timeout: -1)
         case interpreter
         when :powershell
-          Chef_PowerShell::PowerShell.new(script)
+          ChefPowerShell::PowerShell.new(script, timeout: timeout)
         when :pwsh
-          Chef_PowerShell::Pwsh.new(script)
+          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::CommandFailed if the command fails
-      def powershell_exec!(script, interpreter = :powershell)
-        cmd = powershell_exec(script, interpreter)
+      # ChefPowerShell::PowerShellExceptions::PowerShellCommandFailed if the command fails
+      def powershell_exec!(script, interpreter = :powershell, **options)
+        cmd = powershell_exec(script, interpreter, **options)
         cmd.error!
         cmd
       end

data/lib/chef-powershell/pwsh.rb

@@ -15,23 +15,24 @@
 # 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
     # bindir directory.
     #
     # @param script [String] script to run
+    # @param timeout [Integer, nil] timeout in seconds.
     # @return [Object] output
-    def initialize(script)
+    def initialize(script, timeout: -1)
       @dll = Pwsh.dll
       super
     end
 
     protected
 
-    def exec(script)
+    def exec(script, timeout: -1)
       # Note that we need to override the location of the shared dotnet core library
       # location. With most .net core applications, you can simply publish them as a
       # "self-contained" application allowing consumers of the application to run them
@@ -46,8 +47,10 @@ class Chef_PowerShell
       original_dotnet_root_x86 = ENV["DOTNET_ROOT(x86)"]
 
       ENV["DOTNET_MULTILEVEL_LOOKUP"] = "0"
-      ENV["DOTNET_ROOT"] = RbConfig::CONFIG["bindir"]
-      ENV["DOTNET_ROOT(x86)"] = RbConfig::CONFIG["bindir"]
+      ENV["DOTNET_ROOT"] = Gem.loaded_specs["chef-powershell"].full_gem_path + "/bin/ruby_bin_folder/AMD64"
+      ENV["DOTNET_ROOT(x86)"] = Gem.loaded_specs["chef-powershell"].full_gem_path + "/bin/ruby_bin_folder/x86"
+
+      @powershell_dll = Gem.loaded_specs["chef-powershell"].full_gem_path + "/bin/ruby_bin_folder/#{ENV["PROCESSOR_ARCHITECTURE"]}/shared/Microsoft.NETCore.App/5.0.0/Chef.PowerShell.Wrapper.Core.dll"
 
       super
     ensure
@@ -64,7 +67,8 @@ class Chef_PowerShell
       # ensures that the correct architecture binaries are installed into the path.
       # Also note that the version of pwsh is determined by which assemblies the dll was
       # built with. To update powershell, those dependencies must be bumped.
-      @dll ||= Dir.glob("#{RbConfig::CONFIG["bindir"]}/**/Chef.PowerShell.Wrapper.Core.dll").last
+      @powershell_dll = Gem.loaded_specs["chef-powershell"].full_gem_path + "/bin/ruby_bin_folder/#{ENV["PROCESSOR_ARCHITECTURE"]}/shared/Microsoft.NETCore.App/5.0.0/Chef.PowerShell.Wrapper.Core.dll"
+      @dll ||= @powershell_dll
     end
   end
 end

data/lib/chef-powershell/version.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: true
+# frozen_string_literal: true
 # Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
@@ -14,7 +14,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-module ChefPowerShell
+module ChefPowerShellModule
   CHEFPOWERSHELL_ROOT = File.expand_path("..", __dir__)
-  VERSION = "1.0.0"
+  VERSION = "1.0.13"
 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,40 +18,45 @@
 
 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
+    file_path = Gem.loaded_specs["chef-powershell"].full_gem_path + "/bin/ruby_bin_folder/#{ENV["PROCESSOR_ARCHITECTURE"]}/"
+    ENV["CHEF_POWERSHELL_BIN"] = file_path
+  end
+
   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")).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
-        execution = object.powershell_exec("$PSVersionTable")
-        expect(execution.result["PSVersion"].to_s.to_i).to be < 6
+      it "uses less than version 7" do
+        execution = object.powershell_exec("$PSVersionTable", :powershell, timeout: -1)
+        expect(execution.result["PSVersion"].to_s.to_i).to be < 7
       end
     end
 
     context "using pwsh interpreter" do
       it "runs a basic command and returns a Chef::PowerShell object" do
-        expect(object.powershell_exec("$PSVersionTable", :pwsh)).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
-        execution = object.powershell_exec("$PSVersionTable", :pwsh)
+        execution = object.powershell_exec("$PSVersionTable", :pwsh, timeout: -1)
         expect(execution.result["PSVersion"]["Major"]).to be >= 7
       end
     end
 
     context "using powershell interpreter" do
       it "runs a basic command and returns a Chef::PowerShell object" do
-        expect(object.powershell_exec("$PSVersionTable", :powershell)).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
-        execution = object.powershell_exec("$PSVersionTable", :powershell)
+        execution = object.powershell_exec("$PSVersionTable", :powershell, timeout: -1)
         expect(execution.result["PSVersion"].to_s.to_i).to be < 6
       end
     end
@@ -75,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")).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,44 +1,44 @@
 --- !ruby/object:Gem::Specification
 name: chef-powershell
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.13
 platform: ruby
 authors:
 - Chef Software, Inc
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-26 00:00:00.000000000 Z
+date: 2022-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.15'
 - !ruby/object:Gem::Dependency
   name: ffi-yajl
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: 
+        version: '2.4'
+description:
 email:
 - oss@chef.io
 executables: []
@@ -47,12 +47,10 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - Rakefile
-- bin/powershell/chef/chef.psm1
-- bin/ruby_bin_folder/AMD64/Chef.PowerShell.Wrapper.dll
 - bin/ruby_bin_folder/AMD64/Chef.PowerShell.dll
+- bin/ruby_bin_folder/AMD64/Chef.Powershell.Wrapper.dll
 - bin/ruby_bin_folder/AMD64/Ijwhost.dll
 - bin/ruby_bin_folder/AMD64/Newtonsoft.Json.dll
-- bin/ruby_bin_folder/AMD64/canary.txt
 - bin/ruby_bin_folder/AMD64/concrt140.dll
 - bin/ruby_bin_folder/AMD64/host/fxr/5.0.0/hostfxr.dll
 - bin/ruby_bin_folder/AMD64/msvcp140.dll
@@ -331,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.20.51904.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/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
@@ -660,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
@@ -668,16 +665,16 @@ files:
 - lib/chef-powershell/version.rb
 - lib/chef-powershell/wide_string.rb
 - spec/unit/powershell_exec_spec.rb
-homepage: https://github.com/chef/chef/tree/main/chef-powershell
+homepage: https://github.com/chef/chef-powershell-shim
 licenses:
 - Apache-2.0
 metadata:
   bug_tracker_uri: https://github.com/chef/chef/issues
-  changelog_uri: https://github.com/chef/chef/blob/main/CHANGELOG.md
-  documentation_uri: https://github.com/chef/chef/tree/main/chef-powershell/README.md
+  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/tree/main/chef-powershell
-post_install_message: 
+  source_code_uri: https://github.com/chef/chef-powershell-shim/chef-powershell
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -693,8 +690,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.29
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.7.6.3
+signing_key:
 specification_version: 4
-summary: Extneral module for accessing and utilizing PowerShell
+summary: External Chef module for accessing and utilizing PowerShell
 test_files: []