wright 0.0.1 → 0.1.0

data/spec/spec_helper.rb

@@ -0,0 +1,35 @@
+require_relative 'spec_helpers/fake_capture3'
+
+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
+
+module Wright
+  # extend Wright::Config to pass on clear for tests
+  class Config
+    class << self
+      attr_accessor :config_hash
+    end
+  end
+end
+
+def reset_logger(log_level = Wright::Logger::DEBUG)
+  Wright.log = Wright::Logger.new
+  Wright.log.formatter = Wright::Logger::Formatter.new
+  Wright.log.level = log_level
+end
+
+reset_logger(Wright::Logger::FATAL)
+
+require 'minitest/autorun'

data/spec/spec_helpers/fake_capture3.rb

@@ -0,0 +1,47 @@
+require 'minitest/mock'
+require 'open3'
+
+# Open3::capture3 replacement that reads stdout, stderr and return
+# values from the filesystem
+class FakeCapture3
+  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)
+    end
+  end
+
+  def expect(command)
+    @mock_open3.expect(:capture3, return_values(command), [@env, command])
+  end
+
+  def stub
+    Open3.stub :capture3, @capture3_stub do
+      yield if block_given?
+    end
+    @mock_open3.verify
+  end
+
+  private
+
+  def return_values(command)
+    filename = command.gsub(' ', '_')
+    command_stdout = File.read("#{@basedir}/#{filename}.stdout")
+    command_stderr = File.read("#{@basedir}/#{filename}.stderr")
+    command_status = File.read("#{@basedir}/#{filename}.return").chomp == '0'
+    [command_stdout, command_stderr, FakeProcessStatus.new(command_status)]
+  end
+
+  # fake Process::Status replacement
+  class FakeProcessStatus
+    def initialize(success)
+      @success = success
+    end
+
+    def success?
+      @success
+    end
+  end
+end

data/spec/util/activesupport_spec.rb

@@ -0,0 +1,24 @@
+require_relative '../spec_helper'
+
+require 'wright/util/stolen_from_activesupport'
+
+include Wright
+
+describe Util::ActiveSupport do
+  it 'should camelize underscored words' do
+    Util::ActiveSupport.camelize('foo_bar').must_equal 'FooBar'
+  end
+
+  it 'should underscore CamelCase words' do
+    Util::ActiveSupport.underscore('FooBar').must_equal 'foo_bar'
+    Util::ActiveSupport.underscore('FooBar::Baz').must_equal 'foo_bar/baz'
+  end
+
+  it 'should find constants with a given name' do
+    nonexistent = 'ThisConstant::DoesNotExist'
+
+    Util::ActiveSupport.constantize('Wright::Util').must_equal Wright::Util
+    -> { Util::ActiveSupport.constantize(nonexistent) }.must_raise(NameError)
+    Util::ActiveSupport.safe_constantize(nonexistent).must_be_nil
+  end
+end

data/spec/util/file_permissions_spec.rb

@@ -0,0 +1,141 @@
+require_relative '../spec_helper'
+
+require 'wright/util/file_permissions'
+
+include Wright::Util
+
+describe FilePermissions do
+  before(:each) do
+    @file_permissions = FilePermissions.new('somefile', :file)
+    @dir_permissions = FilePermissions.new('somedir', :directory)
+  end
+
+  after(:each) { FakeFS::FileSystem.clear }
+
+  describe 'initialize' do
+    it 'should raise exceptions for incorrect file types' do
+      lambda do
+        FilePermissions.new(@filename, :invalid_file_type)
+      end.must_raise ArgumentError
+    end
+  end
+
+  describe '#uptodate?' do
+    it 'should return false for non-existent files' do
+      FakeFS do
+        @file_permissions.uptodate?.must_equal false
+      end
+    end
+  end
+
+  describe '#update' do
+    it 'should update file modes when using integer modes' do
+      FakeFS do
+        FileUtils.touch(@file_permissions.filename)
+        FileUtils.chmod(0600, @file_permissions.filename)
+        @file_permissions.uptodate?.must_equal true
+        @file_permissions.mode = 0666
+        @file_permissions.uptodate?.must_equal false
+        @file_permissions.update
+        @file_permissions.current_mode.must_equal 0666
+        @file_permissions.uptodate?.must_equal true
+      end
+    end
+
+    it 'should not change file modes when using no-op mode strings' do
+      FakeFS do
+        FileUtils.touch(@file_permissions.filename)
+        FileUtils.chmod(0600, @file_permissions.filename)
+        @file_permissions.mode = 'ugo+'
+        @file_permissions.uptodate?.must_equal true
+        @file_permissions.update
+        @file_permissions.current_mode.must_equal 0600
+        @file_permissions.uptodate?.must_equal true
+      end
+    end
+
+    it 'should update file modes when using symbolic mode strings' do
+      FakeFS do
+        FileUtils.touch(@file_permissions.filename)
+        FileUtils.chmod(0600, @file_permissions.filename)
+        @file_permissions.mode = 'u+rwx,g=rx,o=rX'
+        @file_permissions.uptodate?.must_equal false
+        @file_permissions.update
+        @file_permissions.current_mode.must_equal 0754
+        @file_permissions.uptodate?.must_equal true
+      end
+    end
+
+    it 'should update directory modes when using symbolic mode strings' do
+      FakeFS do
+        FileUtils.mkdir(@dir_permissions.filename)
+        FileUtils.chmod(0600, @dir_permissions.filename)
+        @dir_permissions.mode = 'u+rwx,g=rx,o=rX'
+        @dir_permissions.update
+        @dir_permissions.current_mode.must_equal 0755
+      end
+    end
+
+    it 'should update file owners' do
+      user1 = Etc.getpwent
+      user2 = Etc.getpwent
+      FakeFS do
+        FileUtils.touch(@file_permissions.filename)
+        FileUtils.chown(user1.name, nil, @file_permissions.filename)
+        @file_permissions.current_owner.must_equal user1.uid
+        @file_permissions.owner = user2.name
+        @file_permissions.uptodate?.must_equal false
+        @file_permissions.update
+        @file_permissions.uptodate?.must_equal true
+        @file_permissions.current_owner.must_equal user2.uid
+      end
+    end
+
+    it 'should update file groups' do
+      group1 = Etc.getgrent
+      group2 = Etc.getgrent
+      FakeFS do
+        FileUtils.touch(@file_permissions.filename)
+        FileUtils.chown(nil, group1.name, @file_permissions.filename)
+        @file_permissions.current_group.must_equal group1.gid
+        @file_permissions.group = group2.name
+        @file_permissions.uptodate?.must_equal false
+        @file_permissions.update
+        @file_permissions.uptodate?.must_equal true
+        @file_permissions.current_group.must_equal group2.gid
+      end
+    end
+
+    it 'should respect the current umask for relative file modes' do
+      begin
+        old_umask = File.umask
+
+        File.umask(0000)
+        @file_permissions.mode = 'o='
+        @file_permissions.mode.must_equal 0660
+
+        File.umask(0246)
+        @file_permissions.mode = 'o='
+        @file_permissions.mode.must_equal 0420
+      ensure
+        File.umask(old_umask)
+      end
+    end
+
+    it 'should respect the current umask for relative directory modes' do
+      begin
+        old_umask = File.umask
+
+        File.umask(0000)
+        @dir_permissions.mode = 'o='
+        @dir_permissions.mode.must_equal 0770
+
+        File.umask(0246)
+        @dir_permissions.mode = 'o='
+        @dir_permissions.mode.must_equal 0530
+      ensure
+        File.umask(old_umask)
+      end
+    end
+  end
+end

data/spec/util/file_spec.rb

@@ -0,0 +1,127 @@
+require_relative '../spec_helper'
+
+require 'wright/util/file'
+
+include Wright
+
+describe Util::File do
+  before(:each) do
+    @file = 'somefile'
+    @dir = 'somedir'
+  end
+
+  after(:each) { FakeFS::FileSystem.clear }
+
+  describe 'file_mode' do
+    it 'should return the correct mode for a given file' do
+      FakeFS do
+        FileUtils.touch(@file)
+        FileUtils.chmod(0644, @file)
+        Util::File.file_mode(@file).must_equal 0644
+      end
+    end
+
+    it 'should return nil for non-existing files' do
+      FakeFS { Util::File.file_mode(@file).must_be_nil }
+    end
+  end
+
+  describe 'file_owner' do
+    it 'should return the correct owner for a given file' do
+      FakeFS do
+        FileUtils.touch(@file)
+        pwent = Etc.getpwent
+        File.chown(pwent.uid, pwent.gid, @file)
+        Util::File.file_owner(@file).must_equal pwent.uid
+      end
+    end
+
+    it 'should return nil for non-existing files' do
+      FakeFS { Util::File.file_mode(@file).must_be_nil }
+    end
+  end
+
+  describe 'file_group' do
+    it 'should return the correct group for a given file' do
+      FakeFS do
+        FileUtils.touch(@file)
+        pwent = Etc.getpwent
+        File.chown(pwent.uid, pwent.gid, @file)
+        Util::File.file_group(@file).must_equal pwent.gid
+      end
+    end
+
+    it 'should return nil for non-existing files' do
+      FakeFS { Util::File.file_group(@file).must_be_nil }
+    end
+  end
+
+  describe 'numeric_mode_to_i' do
+    it 'should not change octal integer modes' do
+      Util::File.numeric_mode_to_i(0644).must_equal 0644
+    end
+
+    it 'should convert numeric string modes' do
+      Util::File.numeric_mode_to_i('0644').must_equal 0644
+      Util::File.numeric_mode_to_i('644').must_equal 0644
+    end
+
+    it 'should return nil for non-numeric mode strings' do
+      Util::File.numeric_mode_to_i('banana').must_equal nil
+    end
+  end
+
+  describe 'symbolic_mode_to_i' do
+    it 'should convert symbolic modes for files' do
+      type = :file
+      mode = 00644
+      FakeFS do
+        FileUtils.touch(@file)
+        FileUtils.chmod(mode, @file)
+        Util::File.symbolic_mode_to_i('u=rw,go=r', mode, type).must_equal 0644
+        Util::File.symbolic_mode_to_i('u=r,go+w', mode, type).must_equal 0466
+        Util::File.symbolic_mode_to_i('+x', mode, type).must_equal 0755
+        Util::File.symbolic_mode_to_i('+X', mode, type).must_equal 0644
+        Util::File.symbolic_mode_to_i('a-r', mode, type).must_equal 0200
+        Util::File.symbolic_mode_to_i('+s', mode, type).must_equal 06644
+        Util::File.symbolic_mode_to_i('+t', mode, type).must_equal 01644
+      end
+    end
+
+    it 'should convert symbolic modes for directories' do
+      type = :directory
+      mode = 00644
+      FakeFS do
+        FileUtils.mkdir(@dir)
+        FileUtils.chmod(mode, @dir)
+        Util::File.symbolic_mode_to_i('u=rw,go=r', mode, type).must_equal 0644
+        Util::File.symbolic_mode_to_i('+x', mode, type).must_equal 0755
+        Util::File.symbolic_mode_to_i('+X', mode, type).must_equal 0755
+      end
+    end
+
+    it 'should raise an exception for invalid symbolic modes' do
+      lambda do
+        Util::File.symbolic_mode_to_i('this is not a mode string', nil, :file)
+      end.must_raise ArgumentError
+    end
+  end
+
+  describe 'expand_tilde_path' do
+    it 'should expand tilde paths' do
+      expected = File.join(Etc.getpwnam('root').dir, 'foo')
+      actual = Wright::Util::File.expand_tilde_path('~root/foo')
+      actual.must_equal expected
+    end
+
+    it 'should not expand anything but the first path element' do
+      expected = File.join(Etc.getpwnam('root').dir, 'foo', '..')
+      actual = Wright::Util::File.expand_tilde_path('~root/foo/..')
+      actual.must_equal expected
+    end
+
+    it 'should not expand non-tilde paths' do
+      Wright::Util::File.expand_tilde_path('../foo/bar').must_equal '../foo/bar'
+    end
+  end
+end

data/spec/util/user_spec.rb

@@ -0,0 +1,46 @@
+require_relative '../spec_helper'
+
+require 'wright/util/user'
+
+include Wright
+
+describe Util::User do
+  describe 'user_to_uid' do
+    it 'should leave integer uids alone' do
+      Util::User.user_to_uid(42).must_equal 42
+    end
+
+    it 'should convert user names to uids' do
+      user = Etc.getpwent
+      Util::User.user_to_uid(user.name).must_equal user.uid
+    end
+  end
+
+  describe 'group_to_gid' do
+    it 'should leave integer gids alone' do
+      Util::User.group_to_gid(42).must_equal 42
+    end
+
+    it 'should convert group names to gids' do
+      group = Etc.getgrent
+      Util::User.group_to_gid(group.name).must_equal group.gid
+    end
+  end
+
+  describe 'owner_to_owner_group' do
+    it 'should return non-string owners unmodified' do
+      Util::User.owner_to_owner_group(23).must_equal [23, nil]
+    end
+
+    it 'should convert owner strings to [owner, group] arrays' do
+      Util::User.owner_to_owner_group('foo').must_equal ['foo', nil]
+      Util::User.owner_to_owner_group('foo:bar').must_equal %w(foo bar)
+    end
+
+    it 'should raise exceptions for invalid owner strings' do
+      lambda do
+        Util::User.owner_to_owner_group('foo:bar:baz')
+      end.must_raise ArgumentError
+    end
+  end
+end

data/spec/util_spec.rb

@@ -0,0 +1,80 @@
+require_relative 'spec_helper'
+
+require 'minitest/stub_const'
+require 'wright/util'
+
+def stub_os(target_os)
+  RbConfig.stub_const(:CONFIG, 'target_os' => target_os) do
+    yield
+  end
+end
+
+describe Wright::Util do
+  describe 'filename_to_classname' do
+    it 'should convert filenames to class names' do
+      classname = Wright::Util.filename_to_classname('foo_bar/baz')
+      classname.must_equal 'FooBar::Baz'
+    end
+  end
+
+  describe 'class_to_resource_name' do
+    it 'should convert classes to resource names' do
+      resource_name = Wright::Util.class_to_resource_name(Object)
+      resource_name.must_equal 'object'
+    end
+  end
+
+  describe 'os_family' do
+    before(:each) do
+      @debian_os_release = <<EOS
+PRETTY_NAME="Debian GNU/Linux 7 (wheezy)"
+NAME="Debian GNU/Linux"
+VERSION_ID="7"
+VERSION="7 (wheezy)"
+ID=debian
+ANSI_COLOR="1;31"
+HOME_URL="http://www.debian.org/"
+SUPPORT_URL="http://www.debian.org/support/"
+BUG_REPORT_URL="http://bugs.debian.org/"
+EOS
+      @ubuntu_os_release = <<EOS
+NAME="Ubuntu"
+VERSION="12.04.4 LTS, Precise Pangolin"
+ID=ubuntu
+ID_LIKE=debian
+PRETTY_NAME="Ubuntu precise (12.04.4 LTS)"
+VERSION_ID="12.04"
+EOS
+    end
+
+    after(:each) { FakeFS::FileSystem.clear }
+
+    it 'should detect MacOS X' do
+      stub_os('darwin13') do
+        Wright::Util.os_family.must_equal 'macosx'
+      end
+    end
+
+    it 'should detect GNU/Linux distributions' do
+      stub_os('linux') do
+        FakeFS do
+          FileUtils.mkdir('/etc')
+          FileUtils.touch('/etc/os-release')
+          Wright::Util.os_family.must_equal 'linux'
+
+          File.write('/etc/os-release', @debian_os_release)
+          Wright::Util.os_family.must_equal 'debian'
+
+          File.write('/etc/os-release', @ubuntu_os_release)
+          Wright::Util.os_family.must_equal 'debian'
+        end
+      end
+    end
+
+    it 'should detect other operating systems' do
+      stub_os('and now for something completely different') do
+        Wright::Util.os_family.must_equal 'other'
+      end
+    end
+  end
+end