puppet 7.31.0-universal-darwin → 8.0.1-universal-darwin

data/spec/unit/provider/nameservice/directoryservice_spec.rb

@@ -0,0 +1,157 @@
+require 'spec_helper'
+
+module Puppet::Util::Plist
+end
+
+# We use this as a reasonable way to obtain all the support infrastructure.
+[:group].each do |type_for_this_round|
+  describe Puppet::Type.type(type_for_this_round).provider(:directoryservice) do
+    before do
+      @resource = double("resource")
+      allow(@resource).to receive(:[]).with(:name)
+      @provider = described_class.new(@resource)
+    end
+
+    it "[#6009] should handle nested arrays of members" do
+      current = ["foo", "bar", "baz"]
+      desired = ["foo", ["quux"], "qorp"]
+      group   = 'example'
+
+      allow(@resource).to receive(:[]).with(:name).and_return(group)
+      allow(@resource).to receive(:[]).with(:auth_membership).and_return(true)
+      @provider.instance_variable_set(:@property_value_cache_hash,
+                                      { :members => current })
+
+      %w{bar baz}.each do |del|
+        expect(@provider).to receive(:execute).once.
+          with([:dseditgroup, '-o', 'edit', '-n', '.', '-d', del, group])
+      end
+
+      %w{quux qorp}.each do |add|
+        expect(@provider).to receive(:execute).once.
+          with([:dseditgroup, '-o', 'edit', '-n', '.', '-a', add, group])
+      end
+
+      expect { @provider.set(:members, desired) }.to_not raise_error
+    end
+  end
+end
+
+describe Puppet::Provider::NameService::DirectoryService do
+  context '.single_report' do
+    it 'should use plist data' do
+      allow(Puppet::Provider::NameService::DirectoryService).to receive(:get_ds_path).and_return('Users')
+      allow(Puppet::Provider::NameService::DirectoryService).to receive(:list_all_present).and_return(
+        ['root', 'user1', 'user2', 'resource_name']
+      )
+      allow(Puppet::Provider::NameService::DirectoryService).to receive(:generate_attribute_hash)
+      allow(Puppet::Provider::NameService::DirectoryService).to receive(:execute)
+      expect(Puppet::Provider::NameService::DirectoryService).to receive(:parse_dscl_plist_data)
+
+      Puppet::Provider::NameService::DirectoryService.single_report('resource_name')
+    end
+  end
+
+  context '.get_exec_preamble' do
+    it 'should use plist data' do
+      allow(Puppet::Provider::NameService::DirectoryService).to receive(:get_ds_path).and_return('Users')
+
+      expect(Puppet::Provider::NameService::DirectoryService.get_exec_preamble('-list')).to include("-plist")
+    end
+  end
+
+  context 'password behavior' do
+    # The below is a binary plist containing a ShadowHashData key which CONTAINS
+    # another binary plist. The nested binary plist contains a 'SALTED-SHA512'
+    # key that contains a base64 encoded salted-SHA512 password hash...
+    let (:binary_plist) { "bplist00\324\001\002\003\004\005\006\a\bXCRAM-MD5RNT]SALTED-SHA512[RECOVERABLEO\020 \231k2\3360\200GI\201\355J\216\202\215y\243\001\206J\300\363\032\031\022\006\2359\024\257\217<\361O\020\020F\353\at\377\277\226\276c\306\254\031\037J(\235O\020D\335\006{\3744g@\377z\204\322\r\332t\021\330\n\003\246K\223\356\034!P\261\305t\035\346\352p\206\003n\247MMA\310\301Z<\366\246\023\0161W3\340\357\000\317T\t\301\311+\204\246L7\276\370\320*\245O\021\002\000k\024\221\270x\353\001\237\346D}\377?\265]\356+\243\v[\350\316a\340h\376<\322\266\327\016\306n\272r\t\212A\253L\216\214\205\016\241 [\360/\335\002#\\A\372\241a\261\346\346\\\251\330\312\365\016\n\341\017\016\225&;\322\\\004*\ru\316\372\a \362?8\031\247\231\030\030\267\315\023\v\343{@\227\301s\372h\212\000a\244&\231\366\nt\277\2036,\027bZ+\223W\212g\333`\264\331N\306\307\362\257(^~ b\262\247&\231\261t\341\231%\244\247\203eOt\365\271\201\273\330\350\363C^A\327F\214!\217hgf\e\320k\260n\315u~\336\371M\t\235k\230S\375\311\303\240\351\037d\273\321y\335=K\016`_\317\230\2612_\023K\036\350\v\232\323Y\310\317_\035\227%\237\v\340\023\016\243\233\025\306:\227\351\370\364x\234\231\266\367\016w\275\333-\351\210}\375x\034\262\272kRuHa\362T/F!\347B\231O`K\304\037'k$$\245h)e\363\365mT\b\317\\2\361\026\351\254\375Jl1~\r\371\267\352\2322I\341\272\376\243^Un\266E7\230[VocUJ\220N\2116D/\025f=\213\314\325\vG}\311\360\377DT\307m\261&\263\340\272\243_\020\271rG^BW\210\030l\344\0324\335\233\300\023\272\225Im\330\n\227*Yv[\006\315\330y'\a\321\373\273A\240\305F{S\246I#/\355\2425\031\031GGF\270y\n\331\004\023G@\331\000\361\343\350\264$\032\355_\210y\000\205\342\375\212q\024\004\026W:\205 \363v?\035\270L-\270=\022\323\2003\v\336\277\t\237\356\374\n\267n\003\367\342\330;\371S\326\016`B6@Njm>\240\021%\336\345\002(P\204Yn\3279l\0228\264\254\304\2528t\372h\217\347sA\314\345\245\337)]\000\b\000\021\000\032\000\035\000+\0007\000Z\000m\000\264\000\000\000\000\000\000\002\001\000\000\000\000\000\000\000\t\000\000\000\000\000\000\000\000\000\000\000\000\000\000\002\270" }
+
+    # The below is a base64 encoded salted-SHA512 password hash.
+    let (:pw_string) { "\335\006{\3744g@\377z\204\322\r\332t\021\330\n\003\246K\223\356\034!P\261\305t\035\346\352p\206\003n\247MMA\310\301Z<\366\246\023\0161W3\340\357\000\317T\t\301\311+\204\246L7\276\370\320*\245" }
+
+    # The below is a salted-SHA512 password hash in hex.
+    let (:sha512_hash) { 'dd067bfc346740ff7a84d20dda7411d80a03a64b93ee1c2150b1c5741de6ea7086036ea74d4d41c8c15a3cf6a6130e315733e0ef00cf5409c1c92b84a64c37bef8d02aa5' }
+
+    let :plist_path do
+      '/var/db/dslocal/nodes/Default/users/jeff.plist'
+    end
+
+    let :ds_provider do
+      described_class
+    end
+
+    let :shadow_hash_data do
+      {'ShadowHashData' => [binary_plist]}
+    end
+
+    it 'should execute convert_binary_to_hash once when getting the password' do
+      expect(described_class).to receive(:convert_binary_to_hash).and_return({'SALTED-SHA512' => pw_string})
+      expect(Puppet::FileSystem).to receive(:exist?).with(plist_path).once.and_return(true)
+      expect(Puppet::Util::Plist).to receive(:read_plist_file).and_return(shadow_hash_data)
+      described_class.get_password('uid', 'jeff')
+    end
+
+    it 'should fail if a salted-SHA512 password hash is not passed in' do
+      expect {
+        described_class.set_password('jeff', 'uid', 'badpassword')
+      }.to raise_error(RuntimeError, /OS X 10.7 requires a Salted SHA512 hash password of 136 characters./)
+    end
+
+    it 'should convert xml-to-binary and binary-to-xml when setting the pw on >= 10.7' do
+      expect(described_class).to receive(:convert_binary_to_hash).and_return({'SALTED-SHA512' => pw_string})
+      expect(described_class).to receive(:convert_hash_to_binary).and_return(binary_plist)
+      expect(Puppet::FileSystem).to receive(:exist?).with(plist_path).once.and_return(true)
+      expect(Puppet::Util::Plist).to receive(:read_plist_file).and_return(shadow_hash_data)
+      expect(Puppet::Util::Plist).to receive(:write_plist_file).with(shadow_hash_data, plist_path, :binary)
+      described_class.set_password('jeff', 'uid', sha512_hash)
+    end
+
+    it '[#13686] should handle an empty ShadowHashData field in the users plist' do
+      expect(described_class).to receive(:convert_hash_to_binary).and_return(binary_plist)
+      expect(Puppet::FileSystem).to receive(:exist?).with(plist_path).once.and_return(true)
+      expect(Puppet::Util::Plist).to receive(:read_plist_file).and_return({'ShadowHashData' => nil})
+      expect(Puppet::Util::Plist).to receive(:write_plist_file)
+      described_class.set_password('jeff', 'uid', sha512_hash)
+    end
+  end
+
+  context '(#4855) directoryservice group resource failure' do
+    let :provider_class do
+      Puppet::Type.type(:group).provider(:directoryservice)
+    end
+
+    let :group_members do
+      ['root','jeff']
+    end
+
+    let :user_account do
+      ['root']
+    end
+
+    let :stub_resource do
+      double('resource')
+    end
+
+    subject do
+      provider_class.new(stub_resource)
+    end
+
+    before :each do
+      @resource = double("resource")
+      allow(@resource).to receive(:[]).with(:name)
+      @provider = provider_class.new(@resource)
+    end
+
+    it 'should delete a group member if the user does not exist' do
+      allow(stub_resource).to receive(:[]).with(:name).and_return('fake_group')
+      allow(stub_resource).to receive(:name).and_return('fake_group')
+      expect(subject).to receive(:execute).with([:dseditgroup, '-o', 'edit', '-n', '.',
+                                                '-d', 'jeff',
+                                                'fake_group']).and_raise(Puppet::ExecutionFailure, 'it broke')
+      expect(subject).to receive(:execute).with([:dscl, '.', '-delete',
+                                                '/Groups/fake_group', 'GroupMembership',
+                                                'jeff'])
+      subject.remove_unwanted_members(group_members, user_account)
+    end
+  end
+end

data/spec/unit/provider/nameservice_spec.rb

@@ -0,0 +1,398 @@
+require 'spec_helper'
+require 'puppet/provider/nameservice'
+require 'puppet/etc'
+require 'puppet_spec/character_encoding'
+
+Puppet::Type.newtype(:nameservice_dummytype) do
+  newparam(:name)
+  ensurable
+  newproperty(:foo)
+  newproperty(:bar)
+end
+
+Puppet::Type.type(:nameservice_dummytype).provide(:nameservice_dummyprovider, parent: Puppet::Provider::NameService) do
+  def posixmethod(param)
+    param
+  end
+
+  def modifycmd(param, value)
+    []
+  end
+end
+
+describe Puppet::Provider::NameService do
+
+  before :each do
+    provider.class.initvars
+    provider.class.resource_type = faketype
+  end
+
+  # These are values getpwent might give you
+  let :users do
+    [
+      Etc::Passwd.new('root', 'x', 0, 0),
+      Etc::Passwd.new('foo', 'x', 1000, 2000),
+      nil
+    ]
+  end
+
+  # These are values getgrent might give you
+  let :groups do
+    [
+      Etc::Group.new('root', 'x', 0, %w{root}),
+      Etc::Group.new('bin', 'x', 1, %w{root bin daemon}),
+      nil
+    ]
+  end
+
+  # A fake struct besides Etc::Group and Etc::Passwd
+  let :fakestruct do
+    Struct.new(:foo, :bar)
+  end
+
+  # A fake value get<foo>ent might return
+  let :fakeetcobject do
+    fakestruct.new('fooval', 'barval')
+  end
+
+  # The provider sometimes relies on @resource for valid properties so let's
+  # create a fake type with properties that match our fake struct.
+  let :faketype do
+    Puppet::Type.type(:nameservice_dummytype)
+  end
+
+  let :provider do
+    Puppet::Type.type(:nameservice_dummytype).provider(:nameservice_dummyprovider)
+      .new(:name => 'bob', :foo => 'fooval', :bar => 'barval')
+  end
+
+  let :resource do
+    resource = faketype.new(:name => 'bob', :ensure => :present)
+    resource.provider = provider
+    resource
+  end
+
+  # These values simulate what Ruby Etc would return from a host with the "same"
+  # user represented in different encodings on disk.
+  let(:utf_8_jose) { "Jos\u00E9"}
+  let(:utf_8_labeled_as_latin_1_jose) { utf_8_jose.dup.force_encoding(Encoding::ISO_8859_1) }
+  let(:valid_latin1_jose) { utf_8_jose.encode(Encoding::ISO_8859_1)}
+  let(:invalid_utf_8_jose) { valid_latin1_jose.dup.force_encoding(Encoding::UTF_8) }
+  let(:escaped_utf_8_jose) { "Jos\uFFFD".force_encoding(Encoding::UTF_8) }
+
+  let(:utf_8_mixed_users) {
+    [
+      Etc::Passwd.new('root', 'x', 0, 0),
+      Etc::Passwd.new('foo', 'x', 1000, 2000),
+      Etc::Passwd.new(utf_8_jose, utf_8_jose, 1001, 2000), # UTF-8 character
+      # In a UTF-8 environment, ruby will return strings labeled as UTF-8 even if they're not valid in UTF-8
+      Etc::Passwd.new(invalid_utf_8_jose, invalid_utf_8_jose, 1002, 2000),
+      nil
+    ]
+  }
+
+  let(:latin_1_mixed_users) {
+    [
+      # In a LATIN-1 environment, ruby will return *all* strings labeled as LATIN-1
+      Etc::Passwd.new('root'.force_encoding(Encoding::ISO_8859_1), 'x', 0, 0),
+      Etc::Passwd.new('foo'.force_encoding(Encoding::ISO_8859_1), 'x', 1000, 2000),
+      Etc::Passwd.new(utf_8_labeled_as_latin_1_jose, utf_8_labeled_as_latin_1_jose, 1002, 2000),
+      Etc::Passwd.new(valid_latin1_jose, valid_latin1_jose, 1001, 2000), # UTF-8 character
+      nil
+    ]
+  }
+
+  describe "#options" do
+    it "should add options for a valid property" do
+      provider.class.options :foo, :key1 => 'val1', :key2 => 'val2'
+      provider.class.options :bar, :key3 => 'val3'
+      expect(provider.class.option(:foo, :key1)).to eq('val1')
+      expect(provider.class.option(:foo, :key2)).to eq('val2')
+      expect(provider.class.option(:bar, :key3)).to eq('val3')
+    end
+
+    it "should raise an error for an invalid property" do
+      expect { provider.class.options :baz, :key1 => 'val1' }.to raise_error(
+        Puppet::Error, 'baz is not a valid attribute for nameservice_dummytype')
+    end
+  end
+
+  describe "#option" do
+    it "should return the correct value" do
+      provider.class.options :foo, :key1 => 'val1', :key2 => 'val2'
+      expect(provider.class.option(:foo, :key2)).to eq('val2')
+    end
+
+    it "should symbolize the name first" do
+      provider.class.options :foo, :key1 => 'val1', :key2 => 'val2'
+      expect(provider.class.option('foo', :key2)).to eq('val2')
+    end
+
+    it "should return nil if no option has been specified earlier" do
+      expect(provider.class.option(:foo, :key2)).to be_nil
+    end
+
+    it "should return nil if no option for that property has been specified earlier" do
+      provider.class.options :bar, :key2 => 'val2'
+      expect(provider.class.option(:foo, :key2)).to be_nil
+    end
+
+    it "should return nil if no matching key can be found for that property" do
+      provider.class.options :foo, :key3 => 'val2'
+      expect(provider.class.option(:foo, :key2)).to be_nil
+    end
+  end
+
+  describe "#section" do
+    it "should raise an error if resource_type has not been set" do
+      expect(provider.class).to receive(:resource_type).and_return(nil)
+      expect { provider.class.section }.to raise_error Puppet::Error, 'Cannot determine Etc section without a resource type'
+    end
+
+    # the return values are hard coded so I am using types that actually make
+    # use of the nameservice provider
+    it "should return pw for users" do
+      provider.class.resource_type = Puppet::Type.type(:user)
+      expect(provider.class.section).to eq('pw')
+    end
+
+    it "should return gr for groups" do
+      provider.class.resource_type = Puppet::Type.type(:group)
+      expect(provider.class.section).to eq('gr')
+    end
+  end
+
+  describe "instances" do
+    it "should return a list of objects in UTF-8 with any invalid characters replaced with '?'" do
+      # These two tests simulate an environment where there are two users with
+      # the same name on disk, but each name is stored on disk in a different
+      # encoding
+      allow(Etc).to receive(:getpwent).and_return(*utf_8_mixed_users)
+      result = PuppetSpec::CharacterEncoding.with_external_encoding(Encoding::UTF_8) do
+        provider.class.instances
+      end
+      expect(result.map(&:name)).to eq(
+        [
+          'root'.force_encoding(Encoding::UTF_8), # started as UTF-8 on disk, returned unaltered as UTF-8
+          'foo'.force_encoding(Encoding::UTF_8), # started as UTF-8 on disk, returned unaltered as UTF-8
+          utf_8_jose, # started as UTF-8 on disk, returned unaltered as UTF-8
+          escaped_utf_8_jose # started as LATIN-1 on disk, but Etc returned as UTF-8 and we escaped invalid chars
+        ]
+      )
+    end
+
+    it "should have object names in their original encoding/bytes if they would not be valid UTF-8" do
+      allow(Etc).to receive(:getpwent).and_return(*latin_1_mixed_users)
+      result = PuppetSpec::CharacterEncoding.with_external_encoding(Encoding::ISO_8859_1) do
+        provider.class.instances
+      end
+      expect(result.map(&:name)).to eq(
+        [
+          'root'.force_encoding(Encoding::UTF_8), # started as LATIN-1 on disk, we overrode to UTF-8
+          'foo'.force_encoding(Encoding::UTF_8), # started as LATIN-1 on disk, we overrode to UTF-8
+          utf_8_jose, # started as UTF-8 on disk, returned by Etc as LATIN-1, and we overrode to UTF-8
+          valid_latin1_jose # started as LATIN-1 on disk, returned by Etc as valid LATIN-1, and we leave as LATIN-1
+        ]
+      )
+    end
+
+    it "should pass the Puppet::Etc :canonical_name Struct member to the constructor" do
+      users = [ Etc::Passwd.new(invalid_utf_8_jose, invalid_utf_8_jose, 1002, 2000), nil ]
+      allow(Etc).to receive(:getpwent).and_return(*users)
+      expect(provider.class).to receive(:new).with({:name => escaped_utf_8_jose, :canonical_name => invalid_utf_8_jose, :ensure => :present})
+      provider.class.instances
+    end
+  end
+
+  describe "validate" do
+    it "should pass if no check is registered at all" do
+      expect { provider.class.validate(:foo, 300) }.to_not raise_error
+      expect { provider.class.validate('foo', 300) }.to_not raise_error
+    end
+
+    it "should pass if no check for that property is registered" do
+      provider.class.verify(:bar, 'Must be 100') { |val| val == 100 }
+      expect { provider.class.validate(:foo, 300) }.to_not raise_error
+      expect { provider.class.validate('foo', 300) }.to_not raise_error
+    end
+
+    it "should pass if the value is valid" do
+      provider.class.verify(:foo, 'Must be 100') { |val| val == 100 }
+      expect { provider.class.validate(:foo, 100) }.to_not raise_error
+      expect { provider.class.validate('foo', 100) }.to_not raise_error
+    end
+
+    it "should raise an error if the value is invalid" do
+      provider.class.verify(:foo, 'Must be 100') { |val| val == 100 }
+      expect { provider.class.validate(:foo, 200) }.to raise_error(ArgumentError, 'Invalid value 200: Must be 100')
+      expect { provider.class.validate('foo', 200) }.to raise_error(ArgumentError, 'Invalid value 200: Must be 100')
+    end
+  end
+
+  describe "getinfo" do
+    before :each do
+      # with section=foo we'll call Etc.getfoonam instead of getpwnam or getgrnam
+      allow(provider.class).to receive(:section).and_return('foo')
+      resource # initialize the resource so our provider has a @resource instance variable
+    end
+
+    it "should return a hash if we can retrieve something" do
+      expect(Puppet::Etc).to receive(:send).with(:getfoonam, 'bob').and_return(fakeetcobject)
+      expect(provider).to receive(:info2hash).with(fakeetcobject).and_return(:foo => 'fooval', :bar => 'barval')
+      expect(provider.getinfo(true)).to eq({:foo => 'fooval', :bar => 'barval'})
+    end
+
+    it "should return nil if we cannot retrieve anything" do
+      expect(Puppet::Etc).to receive(:send).with(:getfoonam, 'bob').and_raise(ArgumentError, "can't find bob")
+      expect(provider).not_to receive(:info2hash)
+      expect(provider.getinfo(true)).to be_nil
+    end
+
+    # Nameservice instances track the original resource name on disk, before
+    # overriding to UTF-8, in @canonical_name for querying that state on disk
+    # again if needed
+    it "should use the instance's @canonical_name to query the system" do
+      provider_instance = provider.class.new(:name => 'foo', :canonical_name => 'original_foo', :ensure => :present)
+      expect(Puppet::Etc).to receive(:send).with(:getfoonam, 'original_foo')
+      provider_instance.getinfo(true)
+    end
+
+    it "should use the instance's name instead of canonical_name if not supplied during instantiation" do
+      provider_instance = provider.class.new(:name => 'foo', :ensure => :present)
+      expect(Puppet::Etc).to receive(:send).with(:getfoonam, 'foo')
+      provider_instance.getinfo(true)
+    end
+  end
+
+  describe "info2hash" do
+    it "should return a hash with all properties" do
+      expect(provider.info2hash(fakeetcobject)).to eq({ :foo => 'fooval', :bar => 'barval' })
+    end
+  end
+
+  describe "munge" do
+    it "should return the input value if no munge method has be defined" do
+      expect(provider.munge(:foo, 100)).to eq(100)
+    end
+
+    it "should return the munged value otherwise" do
+      provider.class.options(:foo, :munge => proc { |x| x*2 })
+      expect(provider.munge(:foo, 100)).to eq(200)
+    end
+  end
+
+  describe "unmunge" do
+    it "should return the input value if no unmunge method has been defined" do
+      expect(provider.unmunge(:foo, 200)).to eq(200)
+    end
+
+    it "should return the unmunged value otherwise" do
+      provider.class.options(:foo, :unmunge => proc { |x| x/2 })
+      expect(provider.unmunge(:foo, 200)).to eq(100)
+    end
+  end
+
+
+  describe "exists?" do
+    it "should return true if we can retrieve anything" do
+      expect(provider).to receive(:getinfo).with(true).and_return(:foo => 'fooval', :bar => 'barval')
+      expect(provider).to be_exists
+    end
+    it "should return false if we cannot retrieve anything" do
+      expect(provider).to receive(:getinfo).with(true).and_return(nil)
+      expect(provider).not_to be_exists
+    end
+  end
+
+  describe "get" do
+    it "should return the correct getinfo value" do
+      expect(provider).to receive(:getinfo).with(false).and_return(:foo => 'fooval', :bar => 'barval')
+      expect(provider.get(:bar)).to eq('barval')
+    end
+
+    it "should unmunge the value first" do
+      provider.class.options(:bar, :munge => proc { |x| x*2}, :unmunge => proc {|x| x/2})
+      expect(provider).to receive(:getinfo).with(false).and_return(:foo => 200, :bar => 500)
+      expect(provider.get(:bar)).to eq(250)
+    end
+
+    it "should return nil if getinfo cannot retrieve the value" do
+      expect(provider).to receive(:getinfo).with(false).and_return(:foo => 'fooval', :bar => 'barval')
+      expect(provider.get(:no_such_key)).to be_nil
+    end
+
+  end
+
+  describe "set" do
+    before :each do
+      resource # initialize resource so our provider has a @resource object
+      provider.class.verify(:foo, 'Must be 100') { |val| val == 100 }
+    end
+
+    it "should raise an error on invalid values" do
+      expect { provider.set(:foo, 200) }.to raise_error(ArgumentError, 'Invalid value 200: Must be 100')
+    end
+
+    it "should execute the modify command on valid values" do
+      expect(provider).to receive(:modifycmd).with(:foo, 100).and_return(['/bin/modify', '-f', '100' ])
+      expect(provider).to receive(:execute).with(['/bin/modify', '-f', '100'], hash_including(custom_environment: {}))
+      provider.set(:foo, 100)
+    end
+
+    it "should munge the value first" do
+      provider.class.options(:foo, :munge => proc { |x| x*2}, :unmunge => proc {|x| x/2})
+      expect(provider).to receive(:modifycmd).with(:foo, 200).and_return(['/bin/modify', '-f', '200' ])
+      expect(provider).to receive(:execute).with(['/bin/modify', '-f', '200'], hash_including(custom_environment: {}))
+      provider.set(:foo, 100)
+    end
+
+    it "should fail if the modify command fails" do
+      expect(provider).to receive(:modifycmd).with(:foo, 100).and_return(['/bin/modify', '-f', '100' ])
+      expect(provider).to receive(:execute).with(['/bin/modify', '-f', '100'], kind_of(Hash)).and_raise(Puppet::ExecutionFailure, "Execution of '/bin/modify' returned 1: some_failure")
+      expect { provider.set(:foo, 100) }.to raise_error Puppet::Error, /Could not set foo/
+    end
+  end
+
+  describe "comments_insync?" do
+    # comments_insync? overrides Puppet::Property#insync? and will act on an
+    # array containing a should value (the expected value of Puppet::Property
+    # @should)
+    context "given strings with compatible encodings" do
+      it "should return false if the is-value and should-value are not equal" do
+        is_value = "foo"
+        should_value = ["bar"]
+        expect(provider.comments_insync?(is_value, should_value)).to be_falsey
+      end
+
+      it "should return true if the is-value and should-value are equal" do
+        is_value = "foo"
+        should_value = ["foo"]
+        expect(provider.comments_insync?(is_value, should_value)).to be_truthy
+      end
+    end
+
+    context "given strings with incompatible encodings" do
+      let(:snowman_iso) { "\u2603".force_encoding(Encoding::ISO_8859_1) }
+      let(:snowman_utf8) { "\u2603".force_encoding(Encoding::UTF_8) }
+      let(:snowman_binary) { "\u2603".force_encoding(Encoding::ASCII_8BIT) }
+      let(:arabic_heh_utf8) { "\u06FF".force_encoding(Encoding::UTF_8) }
+
+      it "should be able to compare unequal strings and return false" do
+        expect(Encoding.compatible?(snowman_iso, arabic_heh_utf8)).to be_falsey
+        expect(provider.comments_insync?(snowman_iso, [arabic_heh_utf8])).to be_falsey
+      end
+
+      it "should be able to compare equal strings and return true" do
+        expect(Encoding.compatible?(snowman_binary, snowman_utf8)).to be_falsey
+        expect(provider.comments_insync?(snowman_binary, [snowman_utf8])).to be_truthy
+      end
+
+      it "should not manipulate the actual encoding of either string" do
+        expect(Encoding.compatible?(snowman_binary, snowman_utf8)).to be_falsey
+        provider.comments_insync?(snowman_binary, [snowman_utf8])
+        expect(snowman_binary.encoding).to eq(Encoding::ASCII_8BIT)
+        expect(snowman_utf8.encoding).to eq(Encoding::UTF_8)
+      end
+    end
+  end
+end