chef-powershell 1.0.0

data/lib/chef-powershell/version.rb

@@ -0,0 +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.0"
+end

data/lib/chef-powershell/wide_string.rb

@@ -0,0 +1,54 @@
+#
+# Author:: Jay Mundrawala(<jdm@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.
+#
+
+class Chef
+  module Mixin
+    module WideString
+
+      def wstring(str)
+        if str.nil? || str.encoding == Encoding::UTF_16LE
+          str
+        else
+          utf8_to_wide(str)
+        end
+      end
+
+      def utf8_to_wide(ustring)
+        # ensure it is actually UTF-8
+        # Ruby likes to mark binary data as ASCII-8BIT
+        ustring = (ustring + "").force_encoding("UTF-8")
+
+        # ensure we have the double-null termination Windows Wide likes
+        ustring += "\000\000" if ustring.length == 0 || ustring[-1].chr != "\000"
+
+        # encode it all as UTF-16LE AKA Windows Wide Character AKA Windows Unicode
+        ustring.encode("UTF-16LE")
+      end
+
+      def wide_to_utf8(wstring)
+        # ensure it is actually UTF-16LE
+        # Ruby likes to mark binary data as ASCII-8BIT
+        wstring = wstring.force_encoding("UTF-16LE")
+
+        # encode it all as UTF-8 and remove trailing CRLF and NULL characters
+        wstring.encode("UTF-8").strip
+      end
+
+    end
+  end
+end

data/lib/chef-powershell.rb

@@ -0,0 +1,23 @@
+# 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.
+#
+
+require_relative "chef-powershell/powershell_exec"
+
+module ChefPowerShell
+  include Chef_PowerShell::ChefPowerShell::PowershellExec
+end

data/spec/unit/powershell_exec_spec.rb

@@ -0,0 +1,89 @@
+#
+# Author:: Stuart Preston (<stuart@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.
+#
+
+require "chef-powershell"
+
+describe Chef_PowerShell::ChefPowerShell::PowershellExec, :windows_only do
+  let(:powershell_mixin) { Class.new { include Chef_PowerShell::ChefPowerShell::PowershellExec } }
+  subject(:object) { powershell_mixin.new }
+
+  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)
+      end
+
+      it "uses less than version 6" do
+        execution = object.powershell_exec("$PSVersionTable")
+        expect(execution.result["PSVersion"].to_s.to_i).to be < 6
+      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)
+      end
+
+      it "uses greater than version 6" do
+        execution = object.powershell_exec("$PSVersionTable", :pwsh)
+        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)
+      end
+
+      it "uses less than version 6" do
+        execution = object.powershell_exec("$PSVersionTable", :powershell)
+        expect(execution.result["PSVersion"].to_s.to_i).to be < 6
+      end
+    end
+
+    it "runs a command that fails with a non-terminating error and can trap the error via .error?" do
+      execution = object.powershell_exec("this-should-error")
+      expect(execution.error?).to eql(true)
+    end
+
+    it "runs a command that fails with a non-terminating error and can list the errors" do
+      execution = object.powershell_exec("this-should-error")
+      expect(execution.errors).to be_a_kind_of(Array)
+      expect(execution.errors[0]).to be_a_kind_of(String)
+      expect(execution.errors[0]).to include("The term 'this-should-error' is not recognized")
+    end
+
+    it "raises an error if the interpreter is invalid" do
+      expect { object.powershell_exec("this-should-error", :power_mistake) }.to raise_error(ArgumentError)
+    end
+  end
+
+  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)
+    end
+
+    it "raises an error if the command fails" do
+      expect { object.powershell_exec!("this-should-error") }.to raise_error(Chef_PowerShell::PowerShellExceptions::PowerShellCommandFailed)
+    end
+
+    it "raises an error if the interpreter is invalid" do
+      expect { object.powershell_exec!("this-should-error", :power_mistake) }.to raise_error(ArgumentError)
+    end
+  end
+end