wright 0.1.2 → 0.2.0

data/spec/provider/group/gnu_passwd_spec.rb

@@ -0,0 +1,382 @@
+require_relative '../../spec_helper'
+
+require 'wright/provider/group/gnu_passwd'
+require 'fakeetc'
+
+describe Wright::Provider::Group::GnuPasswd do
+  def groupadd(group_name, gid = nil, system = false)
+    options = []
+    options << '--system' if system
+    options += ['-g', gid.to_s] if gid
+    ['groupadd', *options, group_name]
+  end
+
+  def gpasswd(group_name, members)
+    ['gpasswd', '-M', "'#{members.join(',')}'", group_name]
+  end
+
+  def groupmod(group_name, gid)
+    ['groupmod', '-g', gid.to_s, group_name]
+  end
+
+  def groupdel(group_name)
+    ['groupdel', group_name]
+  end
+
+  def group_provider(group_name, gid = nil, members = nil, system = false)
+    group_resource = OpenStruct.new(name: group_name,
+                                    gid: gid,
+                                    members: members,
+                                    system: system)
+    Wright::Provider::Group::GnuPasswd.new(group_resource)
+  end
+
+  before :each do
+    gnu_passwd_dir = File.join(File.dirname(__FILE__), 'gnu_passwd')
+    @fake_capture3 = FakeCapture3.new(gnu_passwd_dir)
+    @create_message = ->(group) { "INFO: create group: '#{group}'\n" }
+    @create_message_dry = lambda do |group|
+      "INFO: (would) create group: '#{group}'\n"
+    end
+    @create_message_debug = lambda do |group|
+      "DEBUG: group already created: '#{group}'\n"
+    end
+    @remove_message = ->(group) { "INFO: remove group: '#{group}'\n" }
+    @remove_message_dry = lambda do |group|
+      "INFO: (would) remove group: '#{group}'\n"
+    end
+    @remove_message_debug = lambda do |group|
+      "DEBUG: group already removed: '#{group}'\n"
+    end
+    @groups = { 'foobar' => { gid: 42, mem: %w(foo bar) },
+                'bazqux' => { gid: 43, mem: %w(baz qux) } }
+    FakeEtc.add_groups(@groups)
+  end
+
+  describe '#create' do
+    it 'should create new groups' do
+      gid = 1234
+      group_name = 'newgroup'
+      group_provider = group_provider(group_name, gid)
+      groupadd_cmd = groupadd(group_name, gid)
+
+      @fake_capture3.expect(groupadd_cmd)
+      @fake_capture3.stub do
+        FakeEtc do
+          lambda do
+            reset_logger
+            group_provider.create
+            group_provider.updated?.must_equal true
+          end.must_output @create_message.call(group_name)
+        end
+      end
+    end
+
+    it 'should create new system groups' do
+      group_name = 'newgroup'
+      gid = nil
+      members = nil
+      system = true
+      group_provider = group_provider(group_name, gid, members, system)
+      groupadd_cmd = groupadd(group_name, gid, system)
+
+      @fake_capture3.expect(groupadd_cmd)
+      @fake_capture3.stub do
+        FakeEtc do
+          lambda do
+            reset_logger
+            group_provider.create
+            group_provider.updated?.must_equal true
+          end.must_output @create_message.call(group_name)
+        end
+      end
+    end
+
+    it 'should not try to create existing groups' do
+      group_name = 'foobar'
+      gid = @groups[group_name][:gid]
+      members = @groups[group_name][:mem]
+      group_provider = group_provider(group_name, gid, members)
+
+      @fake_capture3.stub do
+        FakeEtc do
+          lambda do
+            reset_logger
+            group_provider.create
+            group_provider.updated?.must_equal false
+          end.must_output @create_message_debug.call(group_name)
+        end
+      end
+    end
+
+    it 'should clear member lists for existing groups' do
+      group_name = 'foobar'
+      gid = @groups[group_name][:gid]
+      members = []
+      group_provider = group_provider(group_name, gid, members)
+      gpasswd_cmd = gpasswd(group_name, members)
+
+      @fake_capture3.expect(gpasswd_cmd)
+      @fake_capture3.stub do
+        FakeEtc do
+          lambda do
+            reset_logger
+            group_provider.create
+            group_provider.updated?.must_equal true
+          end.must_output @create_message.call(group_name)
+        end
+      end
+    end
+
+    it 'should update member lists for existing groups' do
+      group_name = 'foobar'
+      gid = @groups[group_name][:gid]
+      members = %w(user1 user2)
+      group_provider = group_provider(group_name, gid, members)
+      gpasswd_cmd = gpasswd(group_name, members)
+
+      @fake_capture3.expect(gpasswd_cmd)
+      @fake_capture3.stub do
+        FakeEtc do
+          lambda do
+            reset_logger
+            group_provider.create
+            group_provider.updated?.must_equal true
+          end.must_output @create_message.call(group_name)
+        end
+      end
+    end
+
+    it 'should update the gid for existing groups' do
+      group_name = 'foobar'
+      gid = @groups[group_name][:gid] + 10
+      group_provider = group_provider(group_name, gid)
+      groupmod_cmd = groupmod(group_name, gid)
+
+      @fake_capture3.expect(groupmod_cmd)
+      @fake_capture3.stub do
+        FakeEtc do
+          lambda do
+            reset_logger
+            group_provider.create
+            group_provider.updated?.must_equal true
+          end.must_output @create_message.call(group_name)
+        end
+      end
+    end
+
+    it 'should report errors by groupadd' do
+      gid = 'ERROR'
+      group_name = 'newgroup'
+      group_provider = group_provider(group_name, gid)
+      groupadd_cmd = groupadd(group_name, gid)
+
+      @fake_capture3.expect(groupadd_cmd)
+      @fake_capture3.stub do
+        FakeEtc do
+          e = -> { group_provider.create }.must_raise RuntimeError
+          wright_error = "cannot create group '#{group_name}'"
+          groupadd_error = "groupadd: invalid group ID '#{gid}'"
+          e.message.must_equal %(#{wright_error}: "#{groupadd_error}")
+        end
+      end
+    end
+
+    it 'should report errors by groupmod' do
+      gid = 'ERROR'
+      group_name = 'foobar'
+      group_provider = group_provider(group_name, gid)
+      groupmod_cmd = groupmod(group_name, gid)
+
+      @fake_capture3.expect(groupmod_cmd)
+      @fake_capture3.stub do
+        FakeEtc do
+          e = -> { group_provider.create }.must_raise RuntimeError
+          wright_error = "cannot create group '#{group_name}'"
+          groupmod_error = "groupmod: invalid group ID '#{gid}'"
+          e.message.must_equal %(#{wright_error}: "#{groupmod_error}")
+        end
+      end
+    end
+
+    it 'should report errors by gpasswd' do
+      user = 'not-a-user'
+      members = [user]
+      group_name = 'foobar'
+      group_provider = group_provider(group_name, nil, members)
+      gpasswd_cmd = gpasswd(group_name, members)
+
+      @fake_capture3.expect(gpasswd_cmd)
+      @fake_capture3.stub do
+        FakeEtc do
+          e = -> { group_provider.create }.must_raise RuntimeError
+          wright_error = "cannot create group '#{group_name}'"
+          gpasswd_error = "gpasswd: user '#{user}' does not exist"
+          e.message.must_equal %(#{wright_error}: "#{gpasswd_error}")
+        end
+      end
+    end
+  end
+
+  describe '#remove' do
+    it 'should remove existing groups' do
+      group_name = 'foobar'
+      group_provider = group_provider(group_name)
+      groupdel_cmd = groupdel(group_name)
+
+      @fake_capture3.expect(groupdel_cmd)
+      @fake_capture3.stub do
+        FakeEtc do
+          lambda do
+            reset_logger
+            group_provider.remove
+            group_provider.updated?.must_equal true
+          end.must_output @remove_message.call(group_name)
+        end
+      end
+    end
+
+    it 'should not try to remove groups that are already removed' do
+      group_name = 'not-a-group'
+      group_provider = group_provider(group_name)
+
+      @fake_capture3.stub do
+        FakeEtc do
+          lambda do
+            reset_logger
+            group_provider.remove
+            group_provider.updated?.must_equal false
+          end.must_output @remove_message_debug.call(group_name)
+        end
+      end
+    end
+
+    it 'should report errors by gpasswd' do
+      group_name = 'bazqux'
+      group_provider = group_provider(group_name)
+      groupdel_cmd = groupdel(group_name)
+
+      @fake_capture3.expect(groupdel_cmd)
+      @fake_capture3.stub do
+        FakeEtc do
+          e = -> { group_provider.remove }.must_raise RuntimeError
+          wright_error = "cannot remove group '#{group_name}'"
+          groupdel_error =
+            "groupdel: cannot remove the primary group of user 'quux'"
+          e.message.must_equal %(#{wright_error}: "#{groupdel_error}")
+        end
+      end
+    end
+  end
+
+  describe 'dry_run' do
+    it 'should not actually create new groups' do
+      gid = 1234
+      group_name = 'newgroup'
+      group_provider = group_provider(group_name, gid)
+
+      @fake_capture3.stub do
+        Wright.dry_run do
+          FakeEtc do
+            lambda do
+              reset_logger
+              group_provider.create
+              group_provider.updated?.must_equal true
+            end.must_output @create_message_dry.call(group_name)
+          end
+        end
+      end
+    end
+
+    it 'should not actually update existing groups' do
+      gid = 1234
+      group_name = 'foobar'
+      members = %w(user1 user2)
+      group_provider = group_provider(group_name, gid, members)
+
+      @fake_capture3.stub do
+        Wright.dry_run do
+          FakeEtc do
+            lambda do
+              reset_logger
+              group_provider.create
+              group_provider.updated?.must_equal true
+            end.must_output @create_message_dry.call(group_name)
+          end
+        end
+      end
+    end
+
+    it 'should not try to create existing groups' do
+      group_name = 'foobar'
+      gid = @groups[group_name][:gid]
+      members = @groups[group_name][:mem]
+      group_provider = group_provider(group_name, gid, members)
+
+      @fake_capture3.stub do
+        Wright.dry_run do
+          FakeEtc do
+            lambda do
+              reset_logger
+              group_provider.create
+              group_provider.updated?.must_equal false
+            end.must_output @create_message_debug.call(group_name)
+          end
+        end
+      end
+    end
+
+    it 'should not actually update existing groups' do
+      group_name = 'foobar'
+      gid = @groups[group_name][:gid] + 10
+      members = %w(user1 user2)
+      group_provider = group_provider(group_name, gid, members)
+
+      @fake_capture3.stub do
+        Wright.dry_run do
+          FakeEtc do
+            lambda do
+              reset_logger
+              group_provider.create
+              group_provider.updated?.must_equal true
+            end.must_output @create_message_dry.call(group_name)
+          end
+        end
+      end
+    end
+
+    it 'should not actually remove groups' do
+      group_name = 'foobar'
+      group_provider = group_provider(group_name)
+
+      @fake_capture3.stub do
+        Wright.dry_run do
+          FakeEtc do
+            lambda do
+              reset_logger
+              group_provider.remove
+              group_provider.updated?.must_equal true
+            end.must_output @remove_message_dry.call(group_name)
+          end
+        end
+      end
+    end
+
+    it 'should not try to remove groups that are already removed' do
+      group_name = 'not-a-group'
+      group_provider = group_provider(group_name)
+
+      @fake_capture3.stub do
+        Wright.dry_run do
+          FakeEtc do
+            lambda do
+              reset_logger
+              group_provider.remove
+              group_provider.updated?.must_equal false
+            end.must_output @remove_message_debug.call(group_name)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/provider/group_spec.rb

@@ -0,0 +1,132 @@
+require_relative '../spec_helper'
+
+require 'fakeetc'
+
+require 'wright/provider'
+require 'wright/provider/group'
+
+describe Wright::Provider::Group do
+  before(:each) do
+    Wright::Provider::Group.send(:public, :uptodate?)
+  end
+
+  after(:each) do
+    Wright::Provider::Group.send(:private, :uptodate?)
+  end
+
+  describe '#uptodate?' do
+    it 'should return the correct status' do
+      resource = OpenStruct.new(name: 'foo')
+      provider = Wright::Provider::Group.new(resource)
+
+      FakeEtc.add_groups('foo' => { gid: 42, mem: %w(user1 user2) })
+      FakeEtc do
+        provider.uptodate?(:create).must_equal true
+        provider.uptodate?(:remove).must_equal false
+      end
+
+      FakeEtc.clear_groups
+      FakeEtc do
+        provider.uptodate?(:create).must_equal false
+        provider.uptodate?(:remove).must_equal true
+      end
+    end
+
+    it 'should return the correct status when given a specific gid' do
+      gid = 52
+      resource = OpenStruct.new(name: 'foo', gid: gid, members: nil)
+      provider = Wright::Provider::Group.new(resource)
+
+      FakeEtc.add_groups('foo' => { gid: 42, mem: [] })
+      FakeEtc do
+        provider.uptodate?(:create).must_equal false
+        provider.uptodate?(:remove).must_equal false
+      end
+
+      FakeEtc.clear_groups
+      FakeEtc.add_groups('foo' => { gid: gid, mem: [] })
+      FakeEtc do
+        provider.uptodate?(:create).must_equal true
+        provider.uptodate?(:remove).must_equal false
+      end
+    end
+
+    it 'should return the correct status when given a specific member list' do
+      members = %w(user1 user2)
+      resource = OpenStruct.new(name: 'foo', gid: nil, members: members)
+      provider = Wright::Provider::Group.new(resource)
+
+      FakeEtc.add_groups('foo' => { gid: 42, mem: [] })
+      FakeEtc do
+        provider.uptodate?(:create).must_equal false
+        provider.uptodate?(:remove).must_equal false
+      end
+
+      FakeEtc.clear_groups
+      FakeEtc.add_groups('foo' => { gid: 42, mem: members })
+      FakeEtc do
+        provider.uptodate?(:create).must_equal true
+        provider.uptodate?(:remove).must_equal false
+      end
+    end
+
+    it 'should raise exceptions for invalid actions' do
+      resource = OpenStruct.new(name: 'foo')
+      provider = Wright::Provider::Group.new(resource)
+      e = -> { provider.uptodate?(:foobarbaz) }.must_raise ArgumentError
+      e.message.must_equal "invalid action 'foobarbaz'"
+    end
+  end
+
+  describe '#add_member' do
+    it 'should raise an exception' do
+      resource = OpenStruct.new(name: 'foo')
+      provider = Wright::Provider::Group.new(resource)
+      lambda do
+        provider.send(:add_member, 'member', 'group')
+      end.must_raise NotImplementedError
+    end
+  end
+
+  describe '#remove_member' do
+    it 'should raise an exception' do
+      resource = OpenStruct.new(name: 'foo')
+      provider = Wright::Provider::Group.new(resource)
+      lambda do
+        provider.send(:remove_member, 'member', 'group')
+      end.must_raise NotImplementedError
+    end
+  end
+
+  describe '#set_members' do
+    it 'should use add_member and remove_member to update the member list' do
+      group_name = 'foo'
+      current_members = %w(user1 user2 user3)
+      target_members = %w(user3 user4 user5)
+      resource = OpenStruct.new(name: group_name,
+                                members: target_members)
+      provider = Wright::Provider::Group.new(resource)
+      Wright::Provider::Group.send(:public, :set_members)
+
+      mock_provider = Minitest::Mock.new
+      add_member_stub = ->(m, g) { mock_provider.add_member(m, g) }
+      remove_member_stub = ->(m, g) { mock_provider.remove_member(m, g) }
+
+      mock_provider.expect(:add_member, true, %W(user4 #{group_name}))
+      mock_provider.expect(:add_member, true, %W(user5 #{group_name}))
+      mock_provider.expect(:remove_member, true, %W(user1 #{group_name}))
+      mock_provider.expect(:remove_member, true, %W(user2 #{group_name}))
+
+      FakeEtc.add_groups('foo' => { gid: 42, mem: current_members })
+      FakeEtc do
+        provider.stub(:add_member, add_member_stub) do
+          provider.stub(:remove_member, remove_member_stub) do
+            provider.set_members
+          end
+        end
+      end
+      mock_provider.verify
+      Wright::Provider::Group.send(:private, :set_members)
+    end
+  end
+end

data/spec/provider/package/apt/apt-get_install_-qy_not-a-real-package.stderr

@@ -0,0 +1 @@
+E: Unable to locate package not-a-real-package

data/spec/provider/package/apt/{dpkg-query_-s_unknown-package.stderr → dpkg-query_-s_not-a-real-package.stderr}

@@ -1,3 +1,3 @@
-dpkg-query: package 'vlc' is not installed and no information is available
+dpkg-query: package 'not-a-real-package' is not installed and no information is available
 Use dpkg --info (= dpkg-deb --info) to examine archive files,
 and dpkg --contents (= dpkg-deb --contents) to list their contents.

data/spec/provider/package/apt_spec.rb

@@ -2,21 +2,21 @@ require_relative '../../spec_helper'
 
 require 'wright/provider/package/apt'
 
-def dpkg_query(pkg_name)
-  "dpkg-query -s #{pkg_name}"
-end
+describe Wright::Provider::Package::Apt do
+  def dpkg_query(pkg_name)
+    ['dpkg-query', '-s', pkg_name]
+  end
 
-def apt_get(action, pkg_name, pkg_version = nil)
-  version = pkg_version.nil? ? '' : "=#{pkg_version}"
-  "apt-get #{action} -qy #{pkg_name}#{version}"
-end
+  def apt_get(action, pkg_name, pkg_version = nil)
+    version = pkg_version.nil? ? '' : "=#{pkg_version}"
+    ['apt-get', action.to_s, '-qy', pkg_name + version]
+  end
 
-def package_provider(pkg_name, pkg_version = nil)
-  pkg_resource = OpenStruct.new(name: pkg_name, version: pkg_version)
-  Wright::Provider::Package::Apt.new(pkg_resource)
-end
+  def package_provider(pkg_name, pkg_version = nil)
+    pkg_resource = OpenStruct.new(name: pkg_name, version: pkg_version)
+    Wright::Provider::Package::Apt.new(pkg_resource)
+  end
 
-describe Wright::Provider::Package::Apt do
   before :each do
     apt_dir = File.join(File.dirname(__FILE__), 'apt')
     env = { 'DEBIAN_FRONTEND' => 'noninteractive' }
@@ -50,7 +50,7 @@ describe Wright::Provider::Package::Apt do
       end
     end
 
-    it 'should return empty array for missing packages' do
+    it 'should return an empty array for missing packages' do
       pkg_name = 'vlc'
       pkg_versions = []
       pkg_provider = package_provider(pkg_name)
@@ -62,7 +62,7 @@ describe Wright::Provider::Package::Apt do
       end
     end
 
-    it 'should return nil for removed packages' do
+    it 'should return an empty array for removed packages' do
       pkg_name = 'htop'
       pkg_versions = []
       pkg_provider = package_provider(pkg_name)
@@ -73,6 +73,18 @@ describe Wright::Provider::Package::Apt do
         pkg_provider.installed_versions.must_equal pkg_versions
       end
     end
+
+    it 'should return an empty array for unavailable packages' do
+      pkg_name = 'not-a-real-package'
+      pkg_versions = []
+      pkg_provider = package_provider(pkg_name)
+      dpkg_cmd = dpkg_query(pkg_name)
+
+      @fake_capture3.expect(dpkg_cmd)
+      @fake_capture3.stub do
+        pkg_provider.installed_versions.must_equal pkg_versions
+      end
+    end
   end
 
   describe '#install' do
@@ -143,7 +155,7 @@ describe Wright::Provider::Package::Apt do
     end
 
     it 'should raise exceptions for unknown packages' do
-      pkg_name = 'unknown-package'
+      pkg_name = 'not-a-real-package'
       pkg_provider = package_provider(pkg_name)
       dpkg_cmd = dpkg_query(pkg_name)
       apt_cmd = apt_get(:install, pkg_name)

data/spec/provider/package/homebrew/brew_info_--json=v1_cd-discid.return

@@ -0,0 +1 @@
+0

data/spec/provider/package/homebrew/brew_info_--json=v1_cd-discid.stdout

@@ -0,0 +1 @@
+[{"name":"cd-discid","homepage":"http://linukz.org/cd-discid.shtml","versions":{"stable":"1.1","bottle":false,"devel":null,"head":null},"revision":0,"installed":[],"linked_keg":null,"keg_only":null,"dependencies":[],"conflicts_with":[],"caveats":null,"options":[]}]

data/spec/provider/package/homebrew/brew_info_--json=v1_lame.return

@@ -0,0 +1 @@
+0

data/spec/provider/package/homebrew/brew_info_--json=v1_lame.stdout

@@ -0,0 +1 @@
+[{"name":"lame","homepage":"http://lame.sourceforge.net/","versions":{"stable":"3.99.5","bottle":true,"devel":null,"head":null},"revision":0,"installed":[{"version":"3.99.5","used_options":[],"built_as_bottle":null,"poured_from_bottle":false}],"linked_keg":"3.99.5","keg_only":null,"dependencies":[],"conflicts_with":[],"caveats":null,"options":[{"option":"--universal","description":"Build a universal binary"}]}]

data/spec/provider/package/homebrew/brew_info_--json=v1_not-a-real-package.return

@@ -0,0 +1 @@
+1

data/spec/provider/package/homebrew/brew_info_--json=v1_not-a-real-package.stderr

@@ -0,0 +1 @@
+Error: No available formula for not-a-real-package 

data/spec/provider/package/homebrew/brew_install_cd-discid.return

@@ -0,0 +1 @@
+0

data/spec/provider/package/homebrew/brew_install_cd-discid.stdout

@@ -0,0 +1,9 @@
+==> Downloading http://linukz.org/download/cd-discid-1.1.tar.gz
+==> Downloading https://trac.macports.org/export/70630/trunk/dports/audio/cd-discid/files/patch-cd-discid.c.diff
+==> Patching
+patching file cd-discid.c
+Hunk #1 succeeded at 94 with fuzz 2 (offset 8 lines).
+Hunk #2 succeeded at 212 (offset 11 lines).
+Hunk #3 succeeded at 232 (offset 11 lines).
+==> make prefix=/usr/local/Cellar/cd-discid/1.1 CC=clang CFLAGS= install
+🍺  /usr/local/Cellar/cd-discid/1.1: 6 files, 48K, built in 4 seconds

data/spec/provider/package/homebrew/brew_install_not-a-real-package.return

@@ -0,0 +1 @@
+1

data/spec/provider/package/homebrew/brew_install_not-a-real-package.stderr

@@ -0,0 +1 @@
+Error: No available formula for not-a-real-package 

data/spec/provider/package/homebrew/brew_install_not-a-real-package.stdout

@@ -0,0 +1,2 @@
+Searching formulae...
+Searching taps...

data/spec/provider/package/homebrew/brew_uninstall_lame.return

@@ -0,0 +1 @@
+0

data/spec/provider/package/homebrew/brew_uninstall_lame.stdout

@@ -0,0 +1 @@
+Uninstalling /usr/local/Cellar/lame/3.99.5...