path: root/chef/spec/functional/resource/link_spec.rb

#
# Author:: John Keiser (<jkeiser@opscode.com>)
# Copyright:: Copyright (c) 2011 Opscode, Inc.
# License:: Apache License, Version 2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

require 'spec_helper'

if windows?
  require 'chef/win32/file' #probably need this in spec_helper
end

describe Chef::Resource::Link do
  let(:file_base) { "file_spec" }

  let(:base_dir) do
    if windows?
      Chef::ReservedNames::Win32::File.get_long_path_name(Dir.tmpdir.gsub('/', '\\'))
    else
      Dir.tmpdir
    end
  end

  let(:to) do
    File.join(base_dir, make_tmpname("to_spec", nil))
  end
  let(:target_file) do
    File.join(base_dir, make_tmpname("from_spec", nil))
  end

  after(:each) do
    # TODO Windows fails to clean up some symlinks.
    begin
      FileUtils.rm_r(to) if File.exists?(to)
      FileUtils.rm_r(target_file) if File.exists?(target_file)
      FileUtils.rm_r(CHEF_SPEC_BACKUP_PATH) if File.exists?(CHEF_SPEC_BACKUP_PATH)
    rescue
      puts "Could not remove a file: #{$!}"
    end
  end

  def canonicalize(path)
    windows? ? path.gsub('/', '\\') : path
  end

  def symlink(a, b)
    if windows?
      Chef::ReservedNames::Win32::File.symlink(a, b)
    else
      File.symlink(a, b)
    end
  end
  def symlink?(file)
    if windows?
      Chef::ReservedNames::Win32::File.symlink?(file)
    else
      File.symlink?(file)
    end
  end
  def readlink(file)
    if windows?
      Chef::ReservedNames::Win32::File.readlink(file)
    else
      File.readlink(file)
    end
  end
  def link(a, b)
    if windows?
      Chef::ReservedNames::Win32::File.link(a, b)
    else
      File.link(a, b)
    end
  end

  def create_resource
    node = Chef::Node.new
    events = Chef::EventDispatch::Dispatcher.new
    cookbook_repo = File.expand_path(File.join(CHEF_SPEC_DATA, "cookbooks"))
    cookbook_collection = Chef::CookbookCollection.new(Chef::CookbookLoader.new(cookbook_repo))
    run_context = Chef::RunContext.new(node, cookbook_collection, events)
    resource = Chef::Resource::Link.new(target_file, run_context)
    resource.to(to)
    resource
  end

  let!(:resource) do
    create_resource
  end

  shared_examples_for 'delete errors out' do
    it 'delete errors out' do
      lambda { resource.run_action(:delete) }.should raise_error(Chef::Exceptions::Link)
      (File.exist?(target_file) || symlink?(target_file)).should be_true
    end
  end

  shared_context 'delete is noop' do
    describe 'the :delete action' do
      before(:each) do
        @info = []
        Chef::Log.stub!(:info) { |msg| @info << msg }
        resource.run_action(:delete)
      end

      it 'leaves the file deleted' do
        File.exist?(target_file).should be_false
        symlink?(target_file).should be_false
      end
      it 'does not mark the resource updated' do
        resource.should_not be_updated
      end
      it 'does not log that it deleted' do
        @info.include?("link[#{target_file}] deleted").should be_false
      end
    end
  end

  shared_context 'delete succeeds' do
    describe 'the :delete action' do
      before(:each) do
        @info = []
        Chef::Log.stub!(:info) { |msg| @info << msg }
        resource.run_action(:delete)
      end

      it 'deletes the file' do
        File.exist?(target_file).should be_false
        symlink?(target_file).should be_false
      end
      it 'marks the resource updated' do
        resource.should be_updated
      end
      it 'logs that it deleted' do
        @info.include?("link[#{target_file}] deleted").should be_true
      end
    end
  end

  shared_context 'create symbolic link succeeds' do
    describe 'the :create action' do
      before(:each) do
        @info = []
        Chef::Log.stub!(:info) { |msg| @info << msg }
        resource.run_action(:create)
      end

      it 'links to the target file' do
        symlink?(target_file).should be_true
        readlink(target_file).should == canonicalize(to)
      end
      it 'marks the resource updated' do
        resource.should be_updated
      end
      it 'logs that it created' do
        @info.include?("link[#{target_file}] created").should be_true
      end
    end
  end

  shared_context 'create symbolic link is noop' do
    describe 'the :create action' do
      before(:each) do
        @info = []
        Chef::Log.stub!(:info) { |msg| @info << msg }
        resource.run_action(:create)
      end

      it 'leaves the file linked' do
        symlink?(target_file).should be_true
        readlink(target_file).should == canonicalize(to)
      end
      it 'does not mark the resource updated' do
        resource.should_not be_updated
      end
      it 'does not log that it created' do
        @info.include?("link[#{target_file}] created").should be_false
      end
    end
  end

  shared_context 'create hard link succeeds' do
    describe 'the :create action' do
      before(:each) do
        @info = []
        Chef::Log.stub!(:info) { |msg| @info << msg }
        resource.run_action(:create)
      end
      it 'preserves the hard link' do
        File.exists?(target_file).should be_true
        symlink?(target_file).should be_false
        # Writing to one hardlinked file should cause both
        # to have the new value.
        IO.read(to).should == IO.read(target_file)
        File.open(to, "w") { |file| file.write('wowzers') }
        IO.read(target_file).should == 'wowzers'
      end
      it 'marks the resource updated' do
        resource.should be_updated
      end
      it 'logs that it created' do
        @info.include?("link[#{target_file}] created").should be_true
      end
    end
  end

  shared_context 'create hard link is noop' do
    describe 'the :create action' do
      before(:each) do
        @info = []
        Chef::Log.stub!(:info) { |msg| @info << msg }
        resource.run_action(:create)
      end
      it 'links to the target file' do
        File.exists?(target_file).should be_true
        symlink?(target_file).should be_false
        # Writing to one hardlinked file should cause both
        # to have the new value.
        IO.read(to).should == IO.read(target_file)
        File.open(to, "w") { |file| file.write('wowzers') }
        IO.read(target_file).should == 'wowzers'
      end
      it 'does not mark the resource updated' do
        resource.should_not be_updated
      end
      it 'does not log that it created' do
        @info.include?("link[#{target_file}] created").should be_false
      end
    end
  end

  context "is symbolic" do

    context 'when the link destination is a file' do
      before(:each) do
        File.open(to, "w") do |file|
          file.write('woohoo')
        end
      end
      context 'and the link does not yet exist' do
        include_context 'create symbolic link succeeds'
        include_context 'delete is noop'
      end
      context 'and the link already exists and is a symbolic link' do
        context 'pointing at the target' do
          before(:each) do
            symlink(to, target_file)
            symlink?(target_file).should be_true
            readlink(target_file).should == canonicalize(to)
          end
          include_context 'create symbolic link is noop'
          include_context 'delete succeeds'
          it 'the :delete action does not delete the target file' do
            resource.run_action(:delete)
            File.exists?(to).should be_true
          end
        end
        context 'pointing somewhere else' do
          before(:each) do
            @other_target = File.join(base_dir, make_tmpname('other_spec', nil))
            File.open(@other_target, 'w') { |file| file.write('eek') }
            symlink(@other_target, target_file)
            symlink?(target_file).should be_true
            readlink(target_file).should == @other_target
          end
          after(:each) do
            File.delete(@other_target)
          end
          include_context 'create symbolic link succeeds'
          include_context 'delete succeeds'
          it 'the :delete action does not delete the target file' do
            resource.run_action(:delete)
            File.exists?(to).should be_true
          end
        end
        context 'pointing nowhere' do
          before(:each) do
            nonexistent = File.join(base_dir, make_tmpname('nonexistent_spec', nil))
            symlink(nonexistent, target_file)
            symlink?(target_file).should be_true
            readlink(target_file).should == nonexistent
          end
          include_context 'create symbolic link succeeds'
          include_context 'delete succeeds'
        end
      end
      context 'and the link already exists and is a hard link to the file' do
        before(:each) do
          link(to, target_file)
          File.exists?(target_file).should be_true
          symlink?(target_file).should be_false
        end
        include_context 'create symbolic link succeeds'
        it_behaves_like 'delete errors out'
      end
      context 'and the link already exists and is a file' do
        before(:each) do
          File.open(target_file, 'w') { |file| file.write('eek') }
        end
        include_context 'create symbolic link succeeds'
        it_behaves_like 'delete errors out'
      end
      context 'and the link already exists and is a directory' do
        before(:each) do
          Dir.mkdir(target_file)
        end
        it 'create errors out' do
          if windows?
            lambda { resource.run_action(:create) }.should raise_error(Errno::EACCES)
          elsif os_x? or solaris? or freebsd?
            lambda { resource.run_action(:create) }.should raise_error(Errno::EPERM)
          else
            lambda { resource.run_action(:create) }.should raise_error(Errno::EISDIR)
          end
        end
        it_behaves_like 'delete errors out'
      end
      context 'and the link already exists and is not writeable to this user', :pending do
      end
      it_behaves_like 'a securable resource' do
        let(:path) { target_file }
        def allowed_acl(sid, expected_perms)
          [ ACE.access_allowed(sid, expected_perms[:specific]) ]
        end
        def denied_acl(sid, expected_perms)
          [ ACE.access_denied(sid, expected_perms[:specific]) ]
        end
      end
    end
    context 'when the link destination is a directory' do
      before(:each) do
        Dir.mkdir(to)
      end
      # On Windows, readlink fails to open the link.  FILE_FLAG_OPEN_REPARSE_POINT
      # might help, from http://msdn.microsoft.com/en-us/library/windows/desktop/aa363858(v=vs.85).aspx
      context 'and the link does not yet exist' do
        include_context 'create symbolic link succeeds'
        include_context 'delete is noop'
      end
    end
    context "when the link destination is a symbolic link" do
      context 'to a file that exists' do
        before(:each) do
          @other_target = File.join(base_dir, make_tmpname("other_spec", nil))
          File.open(@other_target, "w") { |file| file.write("eek") }
          symlink(@other_target, to)
          symlink?(to).should be_true
          readlink(to).should == @other_target
        end
        after(:each) do
          File.delete(@other_target)
        end
        context 'and the link does not yet exist' do
          include_context 'create symbolic link succeeds'
          include_context 'delete is noop'
        end
      end
      context 'to a file that does not exist' do
        before(:each) do
          @other_target = File.join(base_dir, make_tmpname("other_spec", nil))
          symlink(@other_target, to)
          symlink?(to).should be_true
          readlink(to).should == @other_target
        end
        context 'and the link does not yet exist' do
          include_context 'create symbolic link succeeds'
          include_context 'delete is noop'
        end
      end
    end
    context "when the link destination is not readable to this user", :pending do
    end
    context "when the link destination does not exist" do
      include_context 'create symbolic link succeeds'
      include_context 'delete is noop'
    end

    {
      '../' => 'with a relative link destination',
      '' => 'with a bare filename for the link destination'
    }.each do |prefix, desc|
      context desc do
        let(:to) { "#{prefix}#{File.basename(absolute_to)}" }
        let(:absolute_to) { File.join(base_dir, make_tmpname("to_spec", nil)) }
        before(:each) do
          resource.to(to)
        end
        context 'when the link does not yet exist' do
          include_context 'create symbolic link succeeds'
          include_context 'delete is noop'
        end
        context 'when the link already exists and points at the target' do
          before(:each) do
            symlink(to, target_file)
            symlink?(target_file).should be_true
            readlink(target_file).should == canonicalize(to)
          end
          include_context 'create symbolic link is noop'
          include_context 'delete succeeds'
        end
        context 'when the link already exists and points at the target with an absolute path' do
          before(:each) do
            symlink(absolute_to, target_file)
            symlink?(target_file).should be_true
            readlink(target_file).should == canonicalize(absolute_to)
          end
          include_context 'create symbolic link succeeds'
          include_context 'delete succeeds'
        end
      end
    end
  end

  context "is a hard link" do
    before(:each) do
      resource.link_type(:hard)
    end

    context "when the link destination is a file" do
      before(:each) do
        File.open(to, "w") do |file|
          file.write('woohoo')
        end
      end
      context "and the link does not yet exist" do
        include_context 'create hard link succeeds'
        include_context 'delete is noop'
      end
      context "and the link already exists and is a symbolic link pointing at the same file" do
        before(:each) do
          symlink(to, target_file)
          symlink?(target_file).should be_true
          readlink(target_file).should == to
        end
        include_context 'create hard link succeeds'
        it_behaves_like 'delete errors out'
      end
      context 'and the link already exists and is a hard link to the file' do
        before(:each) do
          link(to, target_file)
          File.exists?(target_file).should be_true
          symlink?(target_file).should be_false
        end
        include_context 'create hard link is noop'
        include_context 'delete succeeds'
        it 'the :delete action does not delete the target file' do
          resource.run_action(:delete)
          File.exists?(to).should be_true
        end
      end
      context "and the link already exists and is a file" do
        before(:each) do
          File.open(target_file, 'w') { |file| file.write('tomfoolery') }
        end
        include_context 'create hard link succeeds'
        it_behaves_like 'delete errors out'
      end
      context "and the link already exists and is a directory" do
        before(:each) do
          Dir.mkdir(target_file)
        end
        it 'errors out' do
          if windows?
            lambda { resource.run_action(:create) }.should raise_error(Errno::EACCES)
          elsif os_x? or solaris? or freebsd?
            lambda { resource.run_action(:create) }.should raise_error(Errno::EPERM)
          else
            lambda { resource.run_action(:create) }.should raise_error(Errno::EISDIR)
          end
        end
        it_behaves_like 'delete errors out'
      end
      context "and the link already exists and is not writeable to this user", :pending do
      end
      context "and specifies security attributes" do
        before(:each) do
          resource.owner(windows? ? 'Guest' : 'nobody')
        end
        it 'ignores them' do
          resource.run_action(:create)
          if windows?
            Chef::ReservedNames::Win32::Security.get_named_security_info(target_file).owner.should_not == SID.Guest
          else
            File.lstat(target_file).uid.should_not == Etc.getpwnam('nobody').uid
          end
        end
      end
    end
    context "when the link destination is a directory" do
      before(:each) do
        Dir.mkdir(to)
      end
      context 'and the link does not yet exist' do
        it 'create errors out' do
          lambda { resource.run_action(:create) }.should raise_error(windows? ? Chef::Exceptions::Win32APIError : Errno::EPERM)
        end
        include_context 'delete is noop'
      end
    end
    context "when the link destination is a symbolic link" do
      context 'to a real file' do
        before(:each) do
          @other_target = File.join(base_dir, make_tmpname("other_spec", nil))
          File.open(@other_target, "w") { |file| file.write("eek") }
          symlink(@other_target, to)
          symlink?(to).should be_true
          readlink(to).should == @other_target
        end
        after(:each) do
          File.delete(@other_target)
        end
        context 'and the link does not yet exist' do
          it 'links to the target file' do
            resource.run_action(:create)
            File.exists?(target_file).should be_true
            # OS X gets angry about this sort of link.  Bug in OS X, IMO.
            pending('OS X/FreeBSD symlink? and readlink working on hard links to symlinks', :if => (os_x? or freebsd?)) do
              symlink?(target_file).should be_true
              readlink(target_file).should == @other_target
            end
          end
          include_context 'delete is noop'
        end
      end
      context 'to a nonexistent file' do
        before(:each) do
          @other_target = File.join(base_dir, make_tmpname("other_spec", nil))
          symlink(@other_target, to)
          symlink?(to).should be_true
          readlink(to).should == @other_target
        end
        context 'and the link does not yet exist' do
          it 'links to the target file' do
            pending('OS X/FreeBSD fails to create hardlinks to broken symlinks', :if => (os_x? or freebsd?)) do
              resource.run_action(:create)
              # Windows and Unix have different definitions of exists? here, and that's OK.
              if windows?
                File.exists?(target_file).should be_true
              else
                File.exists?(target_file).should be_false
              end
              symlink?(target_file).should be_true
              readlink(target_file).should == @other_target
            end
          end
          include_context 'delete is noop'
        end
      end
    end
    context "when the link destination is not readable to this user", :pending do
    end
    context "when the link destination does not exist" do
      context 'and the link does not yet exist' do
        it 'create errors out' do
          lambda { resource.run_action(:create) }.should raise_error(Errno::ENOENT)
        end
        include_context 'delete is noop'
      end
    end
  end
end