beaker-puppet 0.16.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f99b5ea3158b18360735f58958b7994df0bc002e
-  data.tar.gz: 74049c9e805053122780a57be393f51bf53e2fe5
+  metadata.gz: 58336da53f9d99a2cf8cfdc1953cf93fcc44caae
+  data.tar.gz: 3475c0bda9886d60d226935501df00a66b152860
 SHA512:
-  metadata.gz: c065c58d81584d892e58fab12abc9fabd69d7487351417575d76e5e54230b1c4b4dd26ab01faa41c36ca4b99f41819b85dd27696d055de56db60ef5377817f1d
-  data.tar.gz: 83c38cb1256117144fa55f972c35d4a757f06864bf408e7593bfa5ec0e87ba2e7e18bdae614a6aaa0f91d72aebdb30cb45ce9b9ca7197797b2af21d05cd6ad7c
+  metadata.gz: a5f343170c441d786f464f810b2f80c571a563de4e5e837a317afbae71fce33cb0196478b3735daa58d68341c2affb7f7f46d20788fccd15d8cfc2568e03ce12
+  data.tar.gz: 947b6b1cf35306b1ed9640ae3595713d2970ae1c25db77fe5aa6332b0a2e1e3d4321469c3cef3a7caac5e80944110d2bc51dc78a3ed3b7b3422b9263415ced64

data/acceptance/tests/create_tmpdir_on_test.rb

@@ -0,0 +1,47 @@
+test_name "dsl::helpers::host_helpers #create_tmpdir_on" do
+  step "#create_tmpdir_on returns a temporary directory on the remote system" do
+    tmpdir = create_tmpdir_on default
+    assert_match %r{/}, tmpdir
+    assert_equal 0, on(default, "touch #{tmpdir}/testfile").exit_code
+  end
+
+  step "#create_tmpdir_on uses the specified path prefix when provided" do
+    tmpdir = create_tmpdir_on(default, "mypathprefix")
+    assert_match %r{/mypathprefix}, tmpdir
+    assert_equal 0, on(default, "touch #{tmpdir}/testfile").exit_code
+  end
+
+  step "#create_tmpdir_on fails if a non-existent user is specified" do
+    assert_raises Beaker::Host::CommandFailure do
+      tmpdir = create_tmpdir_on default, '', 'fakeuser'
+    end
+  end
+
+  step "#create_tmpdir_on sets the user if specified" do
+    default.user_present('tmpdirtestuser')
+    tmpdir = create_tmpdir_on(default, nil, 'tmpdirtestuser', nil)
+    assert_match /tmpdirtestuser/, on(default, "ls -ld #{tmpdir}").output
+    default.user_absent('tmpdirtestuser')
+  end
+
+  step "#create_tmpdir_on fails if a non-existent group is specified" do
+    assert_raises Beaker::Host::CommandFailure do
+      tmpdir = create_tmpdir_on default, '', nil, 'fakegroup'
+    end
+  end
+
+  step "#create_tmpdir_on sets the group if specified" do
+    default.group_present('tmpdirtestgroup')
+    tmpdir = create_tmpdir_on(default, nil, nil, 'tmpdirtestgroup')
+    assert_match /testgroup/, on(default, "ls -ld #{tmpdir}").output
+    default.group_absent('tmpdirtestgroup')
+  end
+
+  step "#create_tmpdir_on operates on all hosts if given a hosts array" do
+    tmpdirs = create_tmpdir_on hosts
+    hosts.zip(tmpdirs).each do |(host, tmpdir)|
+      assert_match %r{/}, tmpdir
+      assert_equal 0, on(host, "touch #{tmpdir}/testfile").exit_code
+    end
+  end
+end

data/lib/beaker-puppet/helpers/puppet_helpers.rb

@@ -865,6 +865,55 @@ module Beaker
           sign_certificate_for(default)
         end
 
+        # Create a temp directory on remote host, optionally owned by specified user and group.
+        #
+        # @param [Host, Array<Host>, String, Symbol] hosts One or more hosts to act upon,
+        # or a role (String or Symbol) that identifies one or more hosts.
+        # @param [String] path_prefix A remote path prefix for the new temp directory.
+        # @param [String] user The name of user that should own the temp directory. If
+        # not specified, uses default permissions from tmpdir creation.
+        # @param [String] group The name of group that should own the temp directory.
+        # If not specified, uses default permissions from tmpdir creation.
+        #
+        # @return [String, Array<String>] Returns the name of the newly-created dir, or
+        # an array of names of newly-created dirs per-host
+        #
+        # @note While tempting, this method should not be "optimized" to coalesce calls to
+        # chown user:group when both options are passed, as doing so will muddy the spec.
+        def create_tmpdir_on(hosts, path_prefix = '', user = nil, group = nil)
+          block_on hosts do | host |
+            # create the directory
+            dir = host.tmpdir(path_prefix)
+            # only chown if explicitly passed; don't make assumptions about perms
+            # only `chown user` for cleaner codepaths
+            if user
+              # ensure user exists
+              if not host.user_get(user).success?
+                # clean up
+                host.rm_rf("#{dir}")
+                raise "User #{user} does not exist on #{host}."
+              end
+              # chown only user
+              host.chown(user, dir)
+              # on host, "chown #{user} #{dir}"
+            end
+            # only chgrp if explicitly passed; don't make assumptions about perms
+            if group
+              # ensure group exists
+              if not host.group_get(group).success?
+                # clean up
+                # on host, "rmdir #{dir}"
+                host.rm_rf(dir)
+                raise "Group #{group} does not exist on #{host}."
+              end
+              # chgrp
+              # on host, "chgrp #{group} #{dir}"
+              host.chgrp(group, dir)
+            end
+            dir
+          end
+        end
+
         # Create a temp directory on remote host with a user.  Default user
         # is puppet master user.
         #

data/lib/beaker-puppet/version.rb

@@ -1,3 +1,3 @@
 module BeakerPuppet
-  VERSION = '0.16.0'
+  VERSION = '0.17.0'
 end

data/spec/beaker-puppet/helpers/puppet_helpers_spec.rb

@@ -29,6 +29,98 @@ describe ClassMixedWithDSLHelpers do
   let( :db )     { make_host( 'db',       :roles => %w( database agent )  ) }
   let( :hosts )  { [ master, agent, dash, db, custom ] }
 
+  describe '#create_tmpdir_on' do
+    let(:host) { {'user' => 'puppet', 'group' => 'muppets'} }
+    let(:result_success) { double.as_null_object }
+    let(:result_failure) { double.as_null_object }
+    let(:tmpdir) { '/tmp/beaker.XXXXXX/' }
+
+    before :each do
+      allow( host ).to receive( :tmpdir ).and_return( tmpdir )
+      allow( host ).to receive( :result ).and_return( result_success )
+      allow( result_success ).to receive( :success? ).and_return( true )
+      allow( result_success ).to receive( :stdout ).and_return( 'puppet' )
+      allow( result_failure ).to receive( :success? ).and_return( false )
+    end
+
+    context 'with the path_prefix argument' do
+      it 'passes path_prefix to host.tmpdir' do
+        expect( host ).to receive( :tmpdir ).with( 'beaker' )
+        subject.create_tmpdir_on( host, 'beaker' )
+      end
+    end
+
+    context 'with the user argument' do
+      it 'calls chown when a user is specified' do
+        expect( host ).to receive( :user_get ).and_return( result_success )
+        expect( host ).to receive( :chown ).with( host['user'], tmpdir )
+
+        subject.create_tmpdir_on( host, 'beaker', host['user'] )
+      end
+
+      it 'does not call chown when a user is not specified' do
+        expect( host ).to_not receive( :chown )
+
+        subject.create_tmpdir_on( host, 'beaker' )
+      end
+
+      it 'does not call chown and cleans up when the user does not exist on the host' do
+        expect( host ).to receive( :user_get ).and_return( result_failure )
+        expect( host ).to receive( :rm_rf ).with( tmpdir )
+
+        expect{
+          subject.create_tmpdir_on( host, 'beaker', 'invalid.user' )
+        }.to raise_error( RuntimeError, /User invalid.user does not exist on / )
+      end
+    end
+
+    context 'with the group argument' do
+      it 'calls chgrp when a group is specified' do
+        expect( host ).to receive( :group_get ).and_return( result_success )
+        expect( host ).to receive( :chgrp ).with( host['group'], tmpdir )
+
+        subject.create_tmpdir_on( host, 'beaker', nil, host['group'] )
+      end
+
+      it 'does not call chgrp when a group is not specified' do
+        expect( subject ).to_not receive( :chgrp )
+
+        subject.create_tmpdir_on( host, 'beaker' )
+      end
+
+      it 'does not call chgrp and cleans up when the group does not exist on the host' do
+        expect( host ).to receive( :group_get ).and_return( result_failure )
+        expect( host ).to receive( :rm_rf ).with( tmpdir )
+
+        expect{
+          subject.create_tmpdir_on( host, 'beaker', nil, 'invalid.group' )
+        }.to raise_error( RuntimeError, /Group invalid.group does not exist on / )
+      end
+    end
+
+    context 'with user and group arguments' do
+      # don't coalesce the group into chown, i.e. `chown user:group`
+      # this keeps execution paths simple, clean, and discrete
+      it 'calls chown and chgrp separately' do
+        expect( host ).to receive( :user_get ).and_return( result_success )
+        expect( host ).to receive( :group_get ).and_return( result_success )
+        expect( host ).to receive( :chown ).with( host['user'], tmpdir )
+        expect( host ).to receive( :chgrp ).with( host['group'], tmpdir )
+
+        subject.create_tmpdir_on( host, 'beaker', host['user'], host['group'] )
+      end
+
+      it 'does not pass group to chown' do
+        allow( host ).to receive( :user_get ).and_return( result_success )
+        allow( host ).to receive( :chgrp ).with( host['group'], tmpdir )
+
+        expect( host ).to receive( :group_get ).and_return( result_success )
+        expect( host ).to receive( :chown ).with( host['user'], tmpdir )
+
+        subject.create_tmpdir_on( host, 'beaker', host['user'], host['group'] )
+      end
+    end
+  end
 
   describe '#create_tmpdir_for_user' do
     let(:host) { {} }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: beaker-puppet
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Puppet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-05 00:00:00.000000000 Z
+date: 2018-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -210,6 +210,7 @@ files:
 - acceptance/pre_suite/pkg/install.rb
 - acceptance/tests/README.md
 - acceptance/tests/backwards_compatible.rb
+- acceptance/tests/create_tmpdir_on_test.rb
 - acceptance/tests/install_smoke_test.rb
 - acceptance/tests/stub_host.rb
 - acceptance/tests/web_helpers_test.rb