wright 0.1.2 → 0.2.0

data/spec/provider/user_spec.rb

@@ -0,0 +1,327 @@
+require_relative '../spec_helper'
+
+require 'fakeetc'
+require 'wright/provider'
+require 'wright/provider/group'
+
+describe Wright::Provider::User do
+  before(:each) do
+    username = 'johndoe'
+    @resource = OpenStruct.new(name: username)
+    @create_message = "INFO: create user: '#{username}'\n"
+    @create_message_dry = "INFO: (would) create user: '#{username}'\n"
+    @create_message_debug = "DEBUG: user already created: '#{username}'\n"
+    @remove_message = "INFO: remove user: '#{username}'\n"
+    @remove_message_dry = "INFO: (would) remove user: '#{username}'\n"
+    @remove_message_debug = "DEBUG: user already removed: '#{username}'\n"
+  end
+
+  after(:each) do
+    FakeEtc.clear_users
+    FakeEtc.clear_groups
+  end
+
+  describe '#uptodate?' do
+    before(:each) { Wright::Provider::User.send(:public, :uptodate?) }
+    after(:each) { Wright::Provider::User.send(:private, :uptodate?) }
+
+    it 'should return the correct status' do
+      provider = Wright::Provider::User.new(@resource)
+
+      FakeEtc.add_users('johndoe' => {})
+      FakeEtc do
+        provider.uptodate?(:create).must_equal true
+        provider.uptodate?(:remove).must_equal false
+      end
+
+      FakeEtc.clear_users
+      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 uid' do
+      uid = 52
+      @resource.uid = uid
+      provider = Wright::Provider::User.new(@resource)
+
+      FakeEtc.add_users('johndoe' => { uid: uid + 1 })
+      FakeEtc do
+        provider.uptodate?(:create).must_equal false
+        provider.uptodate?(:remove).must_equal false
+      end
+
+      FakeEtc.clear_users
+      FakeEtc.add_users('johndoe' => { uid: uid })
+      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 group list' do
+      groups = %w(group1 group2)
+      @resource.groups = groups
+      provider = Wright::Provider::User.new(@resource)
+
+      FakeEtc.add_groups('group1' => { mem: [] },
+                         'group2' => { mem: [] })
+      FakeEtc.add_users('johndoe' => {})
+      FakeEtc do
+        provider.uptodate?(:create).must_equal false
+        provider.uptodate?(:remove).must_equal false
+      end
+
+      FakeEtc.clear_groups
+      FakeEtc.add_groups('group1' => { mem: %w(johndoe) },
+                         'group2' => { mem: %w(johndoe) })
+      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 full name' do
+      full_name = 'John Doe'
+      @resource.full_name = full_name
+      provider = Wright::Provider::User.new(@resource)
+
+      FakeEtc.add_users('johndoe' => { gecos: '' })
+      FakeEtc do
+        provider.uptodate?(:create).must_equal false
+        provider.uptodate?(:remove).must_equal false
+      end
+
+      FakeEtc.clear_users
+      FakeEtc.add_users('johndoe' => { gecos: "#{full_name},,," })
+      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 shell' do
+      shell = '/bin/zsh'
+      @resource.shell = shell
+      provider = Wright::Provider::User.new(@resource)
+
+      FakeEtc.add_users('johndoe' => { shell: '' })
+      FakeEtc do
+        provider.uptodate?(:create).must_equal false
+        provider.uptodate?(:remove).must_equal false
+      end
+
+      FakeEtc.clear_users
+      FakeEtc.add_users('johndoe' => { shell: shell })
+      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 home directory' do
+      home = '/home/johndoe'
+      @resource.home = home
+      provider = Wright::Provider::User.new(@resource)
+
+      FakeEtc.add_users('johndoe' => { dir: '' })
+      FakeEtc do
+        provider.uptodate?(:create).must_equal false
+        provider.uptodate?(:remove).must_equal false
+      end
+
+      FakeEtc.clear_users
+      FakeEtc.add_users('johndoe' => { dir: home })
+      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 primary group' do
+      group = { name: 'anonymous', gid: 42 }
+      @resource.primary_group = group[:name]
+      provider = Wright::Provider::User.new(@resource)
+
+      FakeEtc.add_groups(group[:name] => { gid: group[:gid] })
+      FakeEtc.add_users('johndoe' => { gid: group[:gid] + 1 })
+      FakeEtc do
+        provider.uptodate?(:create).must_equal false
+        provider.uptodate?(:remove).must_equal false
+      end
+
+      FakeEtc.clear_users
+      FakeEtc.add_users('johndoe' => { gid: group[:gid] })
+      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 primary group gid' do
+      group = { name: 'anonymous', gid: 42 }
+      @resource.primary_group = group[:gid]
+      provider = Wright::Provider::User.new(@resource)
+
+      FakeEtc.add_groups(group[:name] => { gid: group[:gid] })
+      FakeEtc.add_users('johndoe' => { gid: group[:gid] + 1 })
+      FakeEtc do
+        provider.uptodate?(:create).must_equal false
+        provider.uptodate?(:remove).must_equal false
+      end
+
+      FakeEtc.clear_users
+      FakeEtc.add_users('johndoe' => { gid: group[:gid] })
+      FakeEtc do
+        provider.uptodate?(:create).must_equal true
+        provider.uptodate?(:remove).must_equal false
+      end
+    end
+
+    it 'should raise exceptions for invalid actions' do
+      provider = Wright::Provider::User.new(@resource)
+      e = -> { provider.uptodate?(:foobarbaz) }.must_raise ArgumentError
+      e.message.must_equal "invalid action 'foobarbaz'"
+    end
+  end
+
+  describe '#add_user' do
+    it 'should raise an exception' do
+      provider = Wright::Provider::User.new(@resource)
+      lambda do
+        provider.send(:add_user)
+      end.must_raise NotImplementedError
+    end
+  end
+
+  describe '#update_user' do
+    it 'should raise an exception' do
+      provider = Wright::Provider::User.new(@resource)
+      lambda do
+        provider.send(:update_user)
+      end.must_raise NotImplementedError
+    end
+  end
+
+  describe '#delete_user' do
+    it 'should raise an exception' do
+      provider = Wright::Provider::User.new(@resource)
+      lambda do
+        provider.send(:delete_user)
+      end.must_raise NotImplementedError
+    end
+  end
+
+  describe '#create' do
+    it 'should set the update status when the user is up-to-date' do
+      provider = Wright::Provider::User.new(@resource)
+
+      FakeEtc.add_users('johndoe' => {})
+      FakeEtc do
+        lambda do
+          reset_logger
+          provider.create
+          provider.updated?.must_equal false
+        end.must_output @create_message_debug
+      end
+    end
+
+    it 'should set the update status when the user has to be created' do
+      provider = Wright::Provider::User.new(@resource)
+      mock_provider = Minitest::Mock.new
+
+      mock_provider.expect(:add_user, nil)
+      provider.stub :add_user, -> { mock_provider.add_user } do
+        FakeEtc do
+          lambda do
+            reset_logger
+            provider.create
+            provider.updated?.must_equal true
+          end.must_output @create_message
+        end
+      end
+      mock_provider.verify
+    end
+
+    it 'should set the update status when the user has to be updated' do
+      @resource.shell = '/bin/csh'
+      provider = Wright::Provider::User.new(@resource)
+      mock_provider = Minitest::Mock.new
+
+      mock_provider.expect(:update_user, nil)
+      provider.stub :update_user, -> { mock_provider.update_user } do
+        FakeEtc.add_users('johndoe' => { shell: '/bin/bash' })
+        FakeEtc do
+          lambda do
+            reset_logger
+            provider.create
+            provider.updated?.must_equal true
+          end.must_output @create_message
+        end
+      end
+      mock_provider.verify
+    end
+
+    it 'should set the update status in dry-run mode' do
+      provider = Wright::Provider::User.new(@resource)
+
+      Wright.dry_run do
+        FakeEtc do
+          lambda do
+            reset_logger
+            provider.create
+            provider.updated?.must_equal true
+          end.must_output @create_message_dry
+        end
+      end
+    end
+  end
+
+  describe '#remove' do
+    it 'should set the update status when the user is already removed' do
+      provider = Wright::Provider::User.new(@resource)
+
+      FakeEtc do
+        lambda do
+          reset_logger
+          provider.remove
+          provider.updated?.must_equal false
+        end.must_output @remove_message_debug
+      end
+    end
+
+    it 'should set the update status when the user has to be removed' do
+      provider = Wright::Provider::User.new(@resource)
+      mock_provider = Minitest::Mock.new
+
+      mock_provider.expect(:delete_user, nil)
+      provider.stub :delete_user, -> { mock_provider.delete_user } do
+        FakeEtc.add_users('johndoe' => {})
+        FakeEtc do
+          lambda do
+            reset_logger
+            provider.remove
+            provider.updated?.must_equal true
+          end.must_output @remove_message
+        end
+      end
+      mock_provider.verify
+    end
+
+    it 'should set the update status in dry-run mode' do
+      provider = Wright::Provider::User.new(@resource)
+
+      Wright.dry_run do
+        FakeEtc.add_users('johndoe' => {})
+        FakeEtc do
+          lambda do
+            reset_logger
+            provider.remove
+            provider.updated?.must_equal true
+          end.must_output @remove_message_dry
+        end
+      end
+    end
+  end
+end

data/spec/resource/group_spec.rb

@@ -0,0 +1,29 @@
+require_relative '../spec_helper'
+
+require 'wright/resource/group'
+
+describe Wright::Resource::Group do
+  before(:each) do
+    @group = Wright::Resource::Group.new('foo')
+    @provider = Minitest::Mock.new
+    @group.instance_variable_set(:@provider, @provider)
+  end
+
+  describe '#create' do
+    it 'should ask the provider to create the group' do
+      @provider.expect(:create, nil)
+      @provider.expect(:updated?, true)
+      @group.create
+      @provider.verify
+    end
+  end
+
+  describe '#remove' do
+    it 'should ask the provider to remove the group' do
+      @provider.expect(:remove, nil)
+      @provider.expect(:updated?, true)
+      @group.remove
+      @provider.verify
+    end
+  end
+end

data/spec/resource/package_spec.rb

@@ -0,0 +1,37 @@
+require_relative '../spec_helper'
+
+require 'wright/resource/package'
+
+describe Wright::Resource::Package do
+  before(:each) do
+    @package = Wright::Resource::Package.new('foo')
+    @provider = Minitest::Mock.new
+    @package.instance_variable_set(:@provider, @provider)
+  end
+
+  describe '#installed_versions' do
+    it 'should ask the provider for installed versions' do
+      @provider.expect(:installed_versions, nil)
+      @package.installed_versions
+      @provider.verify
+    end
+  end
+
+  describe '#install' do
+    it 'should ask the provider to install the package' do
+      @provider.expect(:install, nil)
+      @provider.expect(:updated?, true)
+      @package.install
+      @provider.verify
+    end
+  end
+
+  describe '#remove' do
+    it 'should ask the provider to remove the package' do
+      @provider.expect(:remove, nil)
+      @provider.expect(:updated?, true)
+      @package.remove
+      @provider.verify
+    end
+  end
+end

data/spec/resource/user_spec.rb

@@ -0,0 +1,29 @@
+require_relative '../spec_helper'
+
+require 'wright/resource/user'
+
+describe Wright::Resource::User do
+  before(:each) do
+    @user = Wright::Resource::User.new('johndoe')
+    @provider = Minitest::Mock.new
+    @user.instance_variable_set(:@provider, @provider)
+  end
+
+  describe '#create' do
+    it 'should ask the provider to create the user' do
+      @provider.expect(:create, nil)
+      @provider.expect(:updated?, true)
+      @user.create
+      @provider.verify
+    end
+  end
+
+  describe '#remove' do
+    it 'should ask the provider to remove the user' do
+      @provider.expect(:remove, nil)
+      @provider.expect(:updated?, true)
+      @user.remove
+      @provider.verify
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,19 +1,12 @@
 require_relative 'spec_helpers/fake_capture3'
+require_relative 'spec_helpers/test_coverage'
 
 require 'ostruct'
 require 'fakefs/safe'
-require 'wright/logger'
 
-begin
-  require 'simplecov'
-  if ENV['COVERAGE']
-    SimpleCov.start do
-      add_filter '/spec/'
-      add_filter '/vendor/'
-      add_filter '/.bundle/'
-    end
-  end
-end
+measure_coverage if coverage?
+
+require 'wright/logger'
 
 module Wright
   # extend Wright::Config to pass on clear for tests
@@ -25,6 +18,7 @@ module Wright
 end
 
 def reset_logger(log_level = Wright::Logger::DEBUG)
+  Wright::Config[:log] = { colorize: false }
   Wright.log = Wright::Logger.new
   Wright.log.formatter = Wright::Logger::Formatter.new
   Wright.log.level = log_level

data/spec/spec_helpers/fake_capture3.rb

@@ -4,17 +4,20 @@ require 'open3'
 # Open3::capture3 replacement that reads stdout, stderr and return
 # values from the filesystem
 class FakeCapture3
-  def initialize(basedir, env)
+  def initialize(basedir, env = {})
     @basedir = basedir
     @env = env
     @mock_open3 = Minitest::Mock.new
-    @capture3_stub = lambda do |stub_env, stub_command|
-      @mock_open3.capture3(stub_env, stub_command)
+    @capture3_stub = lambda do |stub_env, stub_command, *stub_args|
+      @mock_open3.capture3(stub_env, stub_command, *stub_args)
     end
   end
 
-  def expect(command)
-    @mock_open3.expect(:capture3, return_values(command), [@env, command])
+  def expect(command_and_args, base_filename = nil)
+    command, *args = *command_and_args
+    @mock_open3.expect(:capture3,
+                       return_values(command_and_args, base_filename),
+                       [@env, command, *args])
   end
 
   def stub
@@ -26,8 +29,9 @@ class FakeCapture3
 
   private
 
-  def return_values(command)
-    filename = command.gsub(' ', '_')
+  def return_values(command_and_args, base_filename)
+    filename = base_filename ||
+               command_and_args.join(' ').gsub(' ', '_').gsub('/', 'SLASH')
     command_stdout = File.read("#{@basedir}/#{filename}.stdout")
     command_stderr = File.read("#{@basedir}/#{filename}.stderr")
     command_status = File.read("#{@basedir}/#{filename}.return").chomp == '0'

data/spec/spec_helpers/test_coverage.rb

@@ -0,0 +1,26 @@
+def codeclimate?
+  ENV['CODECLIMATE_REPO_TOKEN']
+end
+
+def simplecov?
+  ENV['COVERAGE']
+end
+
+def coverage?
+  simplecov? || codeclimate?
+end
+
+def measure_coverage
+  require 'simplecov'
+  formatters = []
+  formatters << SimpleCov::Formatter::HTMLFormatter if simplecov?
+
+  if codeclimate?
+    require 'codeclimate-test-reporter'
+    formatters << CodeClimate::TestReporter::Formatter
+  end
+
+  ignored_directories = ['/spec/', '/vendor/', '/.bundle/']
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[*formatters]
+  SimpleCov.start { ignored_directories.each { |dir| add_filter(dir) } }
+end

data/spec/util/activesupport_spec.rb

@@ -20,5 +20,6 @@ describe Util::ActiveSupport do
     Util::ActiveSupport.constantize('Wright::Util').must_equal Wright::Util
     -> { Util::ActiveSupport.constantize(nonexistent) }.must_raise(NameError)
     Util::ActiveSupport.safe_constantize(nonexistent).must_be_nil
+    Util::ActiveSupport.safe_constantize(nil).must_be_nil
   end
 end

data/spec/util/file_permissions_spec.rb

@@ -77,8 +77,8 @@ describe FilePermissions do
     end
 
     it 'should update file owners' do
-      user1 = Etc.getpwent
-      user2 = Etc.getpwent
+      user1 = Etc.getpwuid(0)
+      user2 = Etc.getpwuid(1)
       FakeFS do
         FileUtils.touch(@file_permissions.filename)
         FileUtils.chown(user1.name, nil, @file_permissions.filename)

data/spec/util/file_spec.rb

@@ -8,6 +8,7 @@ describe Util::File do
   before(:each) do
     @file = 'somefile'
     @dir = 'somedir'
+    Etc.setpwent
   end
 
   after(:each) { FakeFS::FileSystem.clear }

data/spec/util/user_spec.rb

@@ -5,6 +5,8 @@ require 'wright/util/user'
 include Wright
 
 describe Util::User do
+  before(:each) { Etc.setpwent }
+
   describe 'user_to_uid' do
     it 'should leave integer uids alone' do
       Util::User.user_to_uid(42).must_equal 42