chef-utils 0.0.1 → 15.5.9

data/spec/unit/dsl/path_sanity_spec.rb

@@ -0,0 +1,85 @@
+#
+# Copyright:: Copyright 2018-2019, 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 "spec_helper"
+
+RSpec.describe ChefUtils::DSL::PathSanity do
+  class PathSanityTestClass
+    include ChefUtils::DSL::PathSanity
+  end
+
+  before do
+    allow(Gem).to receive(:bindir).and_return("/opt/ruby/bin/bundle")
+    allow(RbConfig::CONFIG).to receive(:[]).with("bindir").and_return("/opt/ruby/bin")
+  end
+
+  context "on unix" do
+    before do
+      allow(ChefUtils).to receive(:windows?).and_return(false)
+    end
+
+    let(:test_instance) { PathSanityTestClass.new }
+
+    it "works with no path" do
+      env = {}
+      expect(test_instance.sanitized_path(env)).to eql("#{Gem.bindir}:#{RbConfig::CONFIG["bindir"]}:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin")
+    end
+
+    it "works with nil path" do
+      env = { "PATH" => nil }
+      expect(test_instance.sanitized_path(env)).to eql("#{Gem.bindir}:#{RbConfig::CONFIG["bindir"]}:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin")
+    end
+
+    it "works with empty path" do
+      env = { "PATH" => "" }
+      expect(test_instance.sanitized_path(env)).to eql("#{Gem.bindir}:#{RbConfig::CONFIG["bindir"]}:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin")
+    end
+
+    it "appends the sane_paths to the end of the path, preserving any that already exist, in the same order" do
+      env = { "PATH" => "/bin:/opt/app/bin:/sbin" }
+      expect(test_instance.sanitized_path(env)).to eql("#{Gem.bindir}:#{RbConfig::CONFIG["bindir"]}:/bin:/opt/app/bin:/sbin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin")
+    end
+  end
+
+  context "on windows" do
+    before do
+      allow(ChefUtils).to receive(:windows?).and_return(true)
+    end
+
+    let(:test_instance) { PathSanityTestClass.new }
+
+    it "works with no path" do
+      env = {}
+      expect(test_instance.sanitized_path(env)).to eql("#{Gem.bindir};#{RbConfig::CONFIG["bindir"]}")
+    end
+
+    it "works with nil path" do
+      env = { "PATH" => nil }
+      expect(test_instance.sanitized_path(env)).to eql("#{Gem.bindir};#{RbConfig::CONFIG["bindir"]}")
+    end
+
+    it "works with empty path" do
+      env = { "PATH" => "" }
+      expect(test_instance.sanitized_path(env)).to eql("#{Gem.bindir};#{RbConfig::CONFIG["bindir"]}")
+    end
+
+    it "prepends to an existing path" do
+      env = { "PATH" => '%SystemRoot%\system32;%SystemRoot%;%SystemRoot%\System32\Wbem;%SYSTEMROOT%\System32\WindowsPowerShell\v1.0\\' }
+      expect(test_instance.sanitized_path(env)).to eql("#{Gem.bindir};#{RbConfig::CONFIG["bindir"]};%SystemRoot%\\system32;%SystemRoot%;%SystemRoot%\\System32\\Wbem;%SYSTEMROOT%\\System32\\WindowsPowerShell\\v1.0\\")
+    end
+  end
+end

data/spec/unit/dsl/platform_family_spec.rb

@@ -0,0 +1,222 @@
+#
+# Copyright:: Copyright 2018-2019, 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 "spec_helper"
+require "fauxhai"
+
+def pf_reports_true_for(*args)
+  args.each do |method|
+    it "reports true for #{method}" do
+      expect(described_class.send(method, node)).to be true
+    end
+  end
+  (PLATFORM_FAMILY_HELPERS - [ :windows_ruby? ] - args).each do |method|
+    it "reports false for #{method}" do
+      expect(described_class.send(method, node)).to be false
+    end
+  end
+end
+
+RSpec.describe ChefUtils::DSL::PlatformFamily do
+  let(:node) { Fauxhai.mock(options).data }
+
+  ( HELPER_MODULES - [ described_class ] ).each do |klass|
+    it "does not have methods that collide with #{klass}" do
+      expect((klass.methods - Module.methods) & PLATFORM_FAMILY_HELPERS).to be_empty
+    end
+  end
+
+  ( PLATFORM_FAMILY_HELPERS - [ :windows_ruby? ]).each do |helper|
+    it "has the #{helper} in the ChefUtils module" do
+      expect(ChefUtils).to respond_to(helper)
+    end
+  end
+
+  context "on ubuntu" do
+    let(:options) { { platform: "ubuntu" } }
+
+    pf_reports_true_for(:debian?)
+  end
+
+  context "on raspbian" do
+    let(:options) { { platform: "raspbian" } }
+
+    pf_reports_true_for(:debian?)
+  end
+
+  context "on linuxmint" do
+    let(:options) { { platform: "linuxmint" } }
+
+    pf_reports_true_for(:debian?)
+  end
+
+  context "on debian" do
+    let(:options) { { platform: "debian" } }
+
+    pf_reports_true_for(:debian?)
+  end
+
+  context "on aix" do
+    let(:options) { { platform: "aix" } }
+
+    pf_reports_true_for(:aix?)
+  end
+
+  context "on amazon" do
+    let(:options) { { platform: "amazon" } }
+
+    pf_reports_true_for(:amazon?, :amazon_linux?, :rpm_based?, :fedora_derived?)
+  end
+
+  context "on arch" do
+    let(:options) { { platform: "arch" } }
+
+    pf_reports_true_for(:arch?, :arch_linux?)
+  end
+
+  context "on centos6" do
+    let(:options) { { platform: "centos", version: "6.9" } }
+
+    pf_reports_true_for(:rhel?, :rpm_based?, :fedora_derived?, :redhat_based?, :el?, :rhel6?)
+  end
+
+  context "on centos7" do
+    let(:options) { { platform: "centos", version: "7.7.1908" } }
+
+    pf_reports_true_for(:rhel?, :rpm_based?, :fedora_derived?, :redhat_based?, :el?, :rhel7?)
+  end
+
+  context "on centos8" do
+    let(:options) { { platform: "centos", version: "8" } }
+
+    pf_reports_true_for(:rhel?, :rpm_based?, :fedora_derived?, :redhat_based?, :el?, :rhel8?)
+  end
+
+  context "on clearos7" do
+    let(:options) { { platform: "clearos", version: "7.4" } }
+
+    pf_reports_true_for(:rhel?, :rpm_based?, :fedora_derived?, :redhat_based?, :el?, :rhel7?)
+  end
+
+  context "on dragonfly4" do
+    let(:options) { { platform: "dragonfly4" } }
+
+    pf_reports_true_for(:dragonflybsd?)
+  end
+
+  context "on fedora" do
+    let(:options) { { platform: "fedora" } }
+
+    pf_reports_true_for(:fedora?, :rpm_based?, :fedora_derived?, :redhat_based?)
+  end
+
+  context "on freebsd" do
+    let(:options) { { platform: "freebsd" } }
+
+    pf_reports_true_for(:freebsd?, :bsd_based?)
+  end
+
+  context "on gentoo" do
+    let(:options) { { platform: "gentoo" } }
+
+    pf_reports_true_for(:gentoo?)
+  end
+
+  context "on mac_os_x" do
+    let(:options) { { platform: "mac_os_x" } }
+
+    pf_reports_true_for(:mac_os_x?, :mac?, :osx?, :macos?)
+  end
+
+  context "on openbsd" do
+    let(:options) { { platform: "openbsd" } }
+
+    pf_reports_true_for(:openbsd?, :bsd_based?)
+  end
+
+  context "on opensuse" do
+    let(:options) { { platform: "opensuse" } }
+
+    pf_reports_true_for(:suse?, :rpm_based?)
+  end
+
+  context "on oracle6" do
+    let(:options) { { platform: "oracle", version: "6.10" } }
+
+    pf_reports_true_for(:rhel?, :rpm_based?, :fedora_derived?, :redhat_based?, :el?, :rhel6?)
+  end
+
+  context "on oracle7" do
+    let(:options) { { platform: "oracle", version: "7.6" } }
+
+    pf_reports_true_for(:rhel?, :rpm_based?, :fedora_derived?, :redhat_based?, :el?, :rhel7?)
+  end
+
+  context "on redhat6" do
+    let(:options) { { platform: "redhat", version: "6.9" } }
+
+    pf_reports_true_for(:rhel?, :rpm_based?, :fedora_derived?, :redhat_based?, :el?, :rhel6?)
+  end
+
+  context "on redhat7" do
+    let(:options) { { platform: "redhat", version: "7.6" } }
+
+    pf_reports_true_for(:rhel?, :rpm_based?, :fedora_derived?, :redhat_based?, :el?, :rhel7?)
+  end
+
+  context "on redhat8" do
+    let(:options) { { platform: "redhat", version: "8" } }
+
+    pf_reports_true_for(:rhel?, :rpm_based?, :fedora_derived?, :redhat_based?, :el?, :rhel8?)
+  end
+
+  context "on smartos" do
+    let(:options) { { platform: "smartos" } }
+
+    pf_reports_true_for(:smartos?, :solaris_based?)
+  end
+
+  context "on solaris2" do
+    let(:options) { { platform: "solaris2" } }
+
+    pf_reports_true_for(:solaris?, :solaris2?, :solaris_based?)
+  end
+
+  context "on suse" do
+    let(:options) { { platform: "suse" } }
+
+    pf_reports_true_for(:suse?, :rpm_based?)
+  end
+
+  context "on windows" do
+    let(:options) { { platform: "windows" } }
+
+    pf_reports_true_for(:windows?)
+  end
+
+  context "node-independent windows APIs" do
+    if RUBY_PLATFORM =~ /mswin|mingw32|windows/
+      it "reports true for :windows_ruby?" do
+        expect(described_class.windows_ruby?).to be true
+      end
+    else
+      it "reports false for :windows_ruby?" do
+        expect(described_class.windows_ruby?).to be false
+      end
+    end
+  end
+end

data/spec/unit/dsl/platform_spec.rb

@@ -0,0 +1,234 @@
+#
+# Copyright:: Copyright 2018-2019, 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 "spec_helper"
+require "fauxhai"
+
+def platform_reports_true_for(*args)
+  args.each do |method|
+    it "reports true for #{method} on the module given a node" do
+      expect(described_class.send(method, node)).to be true
+    end
+    it "reports true for #{method} when mixed into a class with a node" do
+      expect(thing_with_a_node.send(method, node)).to be true
+    end
+    it "reports true for #{method} when mixed into a class with a run_context" do
+      expect(thing_with_a_run_context.send(method, node)).to be true
+    end
+    it "reports true for #{method} when mixed into a class with the dsl" do
+      expect(thing_with_the_dsl.send(method, node)).to be true
+    end
+    it "reports true for #{method} on the main class give a node" do
+      expect(ChefUtils.send(method, node)).to be true
+    end
+  end
+  (PLATFORM_HELPERS - args).each do |method|
+    it "reports false for #{method} on the module given a node" do
+      expect(described_class.send(method, node)).to be false
+    end
+    it "reports false for #{method} when mixed into a class with a node" do
+      expect(thing_with_a_node.send(method, node)).to be false
+    end
+    it "reports false for #{method} when mixed into a class with the dsl" do
+      expect(thing_with_the_dsl.send(method, node)).to be false
+    end
+    it "reports false for #{method} on the main class give a node" do
+      expect(ChefUtils.send(method, node)).to be false
+    end
+  end
+end
+
+RSpec.describe ChefUtils::DSL::Platform do
+  let(:node) { Fauxhai.mock(options).data }
+
+  class ThingWithANode
+    include ChefUtils::DSL::Platform
+    attr_accessor :node
+    def initialize(node)
+      @node = node
+    end
+  end
+
+  class ThingWithARunContext
+    include ChefUtils::DSL::Platform
+    class RunContext
+      attr_accessor :node
+    end
+    attr_accessor :run_context
+    def initialize(node)
+      @run_context = RunContext.new
+      run_context.node = node
+    end
+  end
+
+  class ThingWithTheDSL
+    include ChefUtils
+    attr_accessor :node
+    def initialize(node)
+      @node = node
+    end
+  end
+
+  let(:thing_with_a_node) { ThingWithANode.new(node) }
+  let(:thing_with_a_run_context) { ThingWithARunContext.new(node) }
+  let(:thing_with_the_dsl) { ThingWithTheDSL.new(node) }
+
+  ( HELPER_MODULES - [ described_class ] ).each do |klass|
+    it "does not have methods that collide with #{klass}" do
+      expect((klass.methods - Module.methods) & PLATFORM_HELPERS).to be_empty
+    end
+  end
+
+  context "on ubuntu" do
+    let(:options) { { platform: "ubuntu" } }
+
+    platform_reports_true_for(:ubuntu?, :ubuntu_platform?)
+  end
+
+  context "on raspbian" do
+    let(:options) { { platform: "raspbian" } }
+
+    platform_reports_true_for(:raspbian?, :raspbian_platform?)
+  end
+
+  context "on linuxmint" do
+    let(:options) { { platform: "linuxmint" } }
+
+    platform_reports_true_for(:mint?, :linux_mint?, :linuxmint?, :linuxmint_platform?)
+  end
+
+  context "on debian" do
+    let(:options) { { platform: "debian" } }
+
+    platform_reports_true_for(:debian_platform?)
+  end
+
+  context "on aix" do
+    let(:options) { { platform: "aix" } }
+
+    platform_reports_true_for(:aix_platform?)
+  end
+
+  context "on amazon" do
+    let(:options) { { platform: "amazon" } }
+
+    platform_reports_true_for(:amazon_platform?)
+  end
+
+  context "on arch" do
+    let(:options) { { platform: "arch" } }
+
+    platform_reports_true_for(:arch_platform?)
+  end
+
+  context "on centos" do
+    let(:options) { { platform: "centos" } }
+
+    platform_reports_true_for(:centos?, :centos_platform?)
+  end
+
+  context "on clearos" do
+    let(:options) { { platform: "clearos" } }
+
+    platform_reports_true_for(:clearos?, :clearos_platform?)
+  end
+
+  context "on dragonfly4" do
+    let(:options) { { platform: "dragonfly4" } }
+
+    platform_reports_true_for(:dragonfly_platform?)
+  end
+
+  context "on fedora" do
+    let(:options) { { platform: "fedora" } }
+
+    platform_reports_true_for(:fedora_platform?)
+  end
+
+  context "on freebsd" do
+    let(:options) { { platform: "freebsd" } }
+
+    platform_reports_true_for(:freebsd_platform?)
+  end
+
+  context "on gentoo" do
+    let(:options) { { platform: "gentoo" } }
+
+    platform_reports_true_for(:gentoo_platform?)
+  end
+
+  context "on mac_os_x" do
+    let(:options) { { platform: "mac_os_x" } }
+
+    platform_reports_true_for(:mac_os_x_platform?, :macos_platform?)
+  end
+
+  context "on openbsd" do
+    let(:options) { { platform: "openbsd" } }
+
+    platform_reports_true_for(:openbsd_platform?)
+  end
+
+  context "on oracle" do
+    let(:options) { { platform: "oracle" } }
+
+    platform_reports_true_for(:oracle?, :oracle_linux?, :oracle_platform?)
+  end
+
+  context "on redhat" do
+    let(:options) { { platform: "redhat" } }
+
+    platform_reports_true_for(:redhat?, :redhat_enterprise_linux?, :redhat_enterprise?, :redhat_platform?)
+  end
+
+  context "on smartos" do
+    let(:options) { { platform: "smartos" } }
+
+    platform_reports_true_for(:smartos_platform?)
+  end
+
+  context "on solaris2" do
+    let(:options) { { platform: "solaris2" } }
+
+    platform_reports_true_for(:solaris2_platform?)
+  end
+
+  context "on suse" do
+    let(:options) { { platform: "suse" } }
+
+    platform_reports_true_for(:suse_platform?)
+  end
+
+  context "on windows" do
+    let(:options) { { platform: "windows" } }
+
+    platform_reports_true_for(:windows_platform?)
+  end
+
+  context "on opensuseleap" do
+    let(:node) { { "platform" => "opensuseleap", "platform_version" => "15.1", "platform_family" => "suse", "os" => "linux" } }
+
+    platform_reports_true_for(:opensuse_platform?, :opensuseleap_platform?, :opensuse?, :leap_platform?)
+  end
+
+  context "on opensuse" do
+    let(:node) { { "platform" => "opensuse", "platform_version" => "11.0", "platform_family" => "suse", "os" => "linux" } }
+
+    platform_reports_true_for(:opensuse_platform?, :opensuseleap_platform?, :opensuse?, :leap_platform?)
+  end
+
+end