Merge pull request #8165 from jjustice6/solaris_usermod

Create a separate Group provider for Solaris systems.

6 files changed, 182 insertions, 6 deletions

diff --git a/lib/chef/provider/group/solaris.rb b/lib/chef/provider/group/solaris.rb
new file mode 100644
index 0000000000..f5df203b78
--- /dev/null
+++ b/lib/chef/provider/group/solaris.rb
@@ -0,0 +1,74 @@
+#
+# Author:: Joshua Justice (<jjustice6@bloomberg.net>)
+# Copyright:: Copyright 2008-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 "chef/provider/group/groupadd"
+
+class Chef
+  class Provider
+    class Group
+      class Solaris < Chef::Provider::Group::Groupadd
+
+        # this provides line is setup to only catch the solaris2 platform, but
+        # NOT other platforms in the Solaris platform_family. (See usermod provider.)
+        provides :group, platform: "solaris2"
+
+        def load_current_resource
+          super
+        end
+
+        def define_resource_requirements
+          super
+
+          requirements.assert(:all_actions) do |a|
+            a.assertion { ::File.exist?("/usr/sbin/usermod") }
+            a.failure_message Chef::Exceptions::Group, "Could not find binary /usr/sbin/usermod for #{new_resource}"
+            # No whyrun alternative: this component should be available in the base install of any given system that uses it
+          end
+
+          requirements.assert(:modify, :manage) do |a|
+            a.assertion { (new_resource.members.empty? && new_resource.excluded_members.empty?) || new_resource.append }
+            a.failure_message Chef::Exceptions::Group, "setting group members directly is not supported by #{self}, must set append true in group"
+            # No whyrun alternative - this action is simply not supported.
+          end
+        end
+
+        def set_members(members)
+          unless members.empty?
+            members.each do |member|
+              add_member(member)
+            end
+          end
+          unless excluded_members.empty?
+            excluded_members.each do |excluded_member|
+              remove_member(excluded_member)
+            end
+          end
+        end
+
+        def add_member(member)
+          shell_out!("usermod", "-G", "+#{new_resource.group_name}", member)
+        end
+
+        def remove_member(member)
+          shell_out!("usermod", "-G", "-#{new_resource.group_name}", member)
+        end
+
+      end
+    end
+  end
+end
diff --git a/lib/chef/provider/group/usermod.rb b/lib/chef/provider/group/usermod.rb
index 34a563787f..06e05ff54d 100644
--- a/lib/chef/provider/group/usermod.rb
+++ b/lib/chef/provider/group/usermod.rb
@@ -76,10 +76,8 @@ class Chef
 
         def append_flags
           case node[:platform]
-          when "openbsd", "netbsd", "aix", "solaris2", "smartos", "omnios"
+          when "openbsd", "netbsd", "aix", "smartos", "omnios"
             "-G"
-          when "solaris"
-            [ "-a", "-G" ]
           end
         end
 
diff --git a/lib/chef/providers.rb b/lib/chef/providers.rb
index b7b0c52e07..4603be7746 100644
--- a/lib/chef/providers.rb
+++ b/lib/chef/providers.rb
@@ -117,6 +117,7 @@ require "chef/provider/group/gpasswd"
 require "chef/provider/group/groupadd"
 require "chef/provider/group/groupmod"
 require "chef/provider/group/pw"
+require "chef/provider/group/solaris"
 require "chef/provider/group/suse"
 require "chef/provider/group/usermod"
 require "chef/provider/group/windows"
diff --git a/spec/unit/provider/group/solaris_spec.rb b/spec/unit/provider/group/solaris_spec.rb
new file mode 100644
index 0000000000..e6000e6012
--- /dev/null
+++ b/spec/unit/provider/group/solaris_spec.rb
@@ -0,0 +1,105 @@
+#
+# Author:: Joshua Justice (<jjustice6@bloomberg.net>)
+# Copyright:: Copyright 2008-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"
+
+describe Chef::Provider::Group::Solaris do
+  before do
+    @node = Chef::Node.new
+    @events = Chef::EventDispatch::Dispatcher.new
+    @run_context = Chef::RunContext.new(@node, {}, @events)
+    @new_resource = Chef::Resource::Group.new("wheel")
+    @new_resource.members %w{all your base}
+    @new_resource.excluded_members [ ]
+    @provider = Chef::Provider::Group::Solaris.new(@new_resource, @run_context)
+    allow(@provider).to receive(:run_command)
+  end
+
+  describe "modify_group_members" do
+
+    describe "with an empty members array" do
+      before do
+        @new_resource.append(true)
+        @new_resource.members([])
+      end
+
+      it "should log an appropriate message" do
+        expect(@provider).not_to receive(:shell_out_compacted!)
+        @provider.modify_group_members
+      end
+    end
+
+    describe "with supplied members" do
+      platforms = {
+        "solaris2" => [ "-G" ],
+      }
+
+      before do
+        @new_resource.members(%w{all your base})
+        allow(File).to receive(:exist?).and_return(true)
+      end
+
+      it "should raise an error when setting the entire group directly" do
+        @provider.define_resource_requirements
+        @provider.load_current_resource
+        @provider.instance_variable_set("@group_exists", true)
+        @provider.action = :modify
+        expect { @provider.run_action(@provider.process_resource_requirements) }.to raise_error(Chef::Exceptions::Group, "setting group members directly is not supported by #{@provider}, must set append true in group")
+      end
+
+      platforms.each do |platform, flags|
+        it "should usermod +/- each user when the append option is set on #{platform}" do
+          current_resource = @new_resource.dup
+          current_resource.members(%w{are belong to us})
+          @new_resource.excluded_members(%w{are belong to us})
+          @provider.current_resource = current_resource
+          @node.automatic_attrs[:platform] = platform
+          @new_resource.append(true)
+          expect(@provider).to receive(:shell_out_compacted!).with("usermod", *flags, "+wheel", "all")
+          expect(@provider).to receive(:shell_out_compacted!).with("usermod", *flags, "+wheel", "your")
+          expect(@provider).to receive(:shell_out_compacted!).with("usermod", *flags, "+wheel", "base")
+          expect(@provider).to receive(:shell_out_compacted!).with("usermod", *flags, "-wheel", "are")
+          expect(@provider).to receive(:shell_out_compacted!).with("usermod", *flags, "-wheel", "belong")
+          expect(@provider).to receive(:shell_out_compacted!).with("usermod", *flags, "-wheel", "to")
+          expect(@provider).to receive(:shell_out_compacted!).with("usermod", *flags, "-wheel", "us")
+          @provider.modify_group_members
+        end
+
+      end
+    end
+  end
+
+  describe "when loading the current resource" do
+    before(:each) do
+      allow(File).to receive(:exist?).and_return(false)
+      @provider.action = :create
+      @provider.define_resource_requirements
+    end
+
+    it "should raise an error if the required binary /usr/sbin/usermod doesn't exist" do
+      allow(File).to receive(:exist?).and_return(true)
+      expect(File).to receive(:exist?).with("/usr/sbin/usermod").and_return(false)
+      expect { @provider.process_resource_requirements }.to raise_error(Chef::Exceptions::Group)
+    end
+
+    it "shouldn't raise an error if the required binaries exist" do
+      allow(File).to receive(:exist?).and_return(true)
+      expect { @provider.process_resource_requirements }.not_to raise_error
+    end
+  end
+end
diff --git a/spec/unit/provider/group/usermod_spec.rb b/spec/unit/provider/group/usermod_spec.rb
index 3fca15ea8d..752c96c5d3 100644
--- a/spec/unit/provider/group/usermod_spec.rb
+++ b/spec/unit/provider/group/usermod_spec.rb
@@ -48,7 +48,6 @@ describe Chef::Provider::Group::Usermod do
       platforms = {
         "openbsd" => [ "-G" ],
         "netbsd" => [ "-G" ],
-        "solaris" => [ "-a", "-G" ],
         "smartos" => [ "-G" ],
         "omnios" => [ "-G" ],
       }
diff --git a/spec/unit/provider_resolver_spec.rb b/spec/unit/provider_resolver_spec.rb
index 8cef4d4386..9014b873de 100644
--- a/spec/unit/provider_resolver_spec.rb
+++ b/spec/unit/provider_resolver_spec.rb
@@ -847,8 +847,7 @@ describe Chef::ProviderResolver do
               user: [ Chef::Resource::User::SolarisUser, Chef::Provider::User::Solaris ],
               "5.11" => {
                 package: [ Chef::Resource::IpsPackage, Chef::Provider::Package::Ips ],
-              },
-              "5.9" => {
+                group: [ Chef::Resource::Group, Chef::Provider::Group::Solaris ],
               },
             },
           },