File Manager

Path: /opt/chef/embedded/lib/ruby/gems/2.7.0/gems/chef-16.3.45/spec/functional/resource/

Viewing File: file_spec.rb

#
# Author:: Seth Chisamore (<schisamo@chef.io>)
# Copyright:: Copyright (c) Chef Software 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"
require "tmpdir"

describe Chef::Resource::File do
  include_context Chef::Resource::File

  let(:file_base) { "file_spec" }
  let(:expected_content) { "Don't fear the ruby." }

  def create_resource(opts = {})
    events = Chef::EventDispatch::Dispatcher.new
    node = Chef::Node.new
    run_context = Chef::RunContext.new(node, {}, events)

    use_path = if opts[:use_relative_path]
                 Dir.chdir(Dir.tmpdir)
                 File.basename(path)
               else
                 path
               end

    Chef::Resource::File.new(use_path, run_context)
  end

  let(:resource) do
    r = create_resource
    r.content(expected_content)
    r
  end

  let(:resource_without_content) do
    create_resource
  end

  let(:resource_with_relative_path) do
    create_resource(use_relative_path: true)
  end

  let(:unmanaged_content) do
    "This is file content that is not managed by chef"
  end

  let(:current_resource) do
    provider = resource.provider_for_action(resource.action)
    provider.load_current_resource
    provider.current_resource
  end

  let(:default_mode) { (0666 & ~File.umask).to_s(8) }

  it_behaves_like "a file resource"

  it_behaves_like "a securable resource with reporting"

  describe "when running action :create without content" do
    before do
      resource_without_content.run_action(:create)
    end

    context "and the target file does not exist" do
      it "creates the file" do
        expect(File).to exist(path)
      end

      it "is marked updated by last action" do
        expect(resource_without_content).to be_updated_by_last_action
      end
    end
  end

  describe "when using backup" do
    before do
      Chef::Config[:file_backup_path] = CHEF_SPEC_BACKUP_PATH
      resource_without_content.backup(1)
      resource_without_content.run_action(:create)
    end

    let(:backup_glob) { File.join(CHEF_SPEC_BACKUP_PATH, test_file_dir.sub(/^([A-Za-z]:)/, ""), "#{file_base}*") }

    let(:path) do
      # Use native system path
      ChefConfig::PathHelper.canonical_path(File.join(test_file_dir, make_tmpname(file_base)), false)
    end

    it "only stores the number of requested backups" do
      resource_without_content.content("foo")
      resource_without_content.run_action(:create)
      resource_without_content.content("bar")
      resource_without_content.run_action(:create)
      expect(Dir.glob(backup_glob).length).to eq(1)
    end

  end

  # github issue 1842.
  describe "when running action :create on a relative path" do
    before do
      resource_with_relative_path.run_action(:create)
    end

    context "and the file exists" do
      it "should run without an exception" do
        resource_with_relative_path.run_action(:create)
      end
    end
  end

  describe "when running action :touch" do
    context "and the target file does not exist" do
      before do
        resource.run_action(:touch)
      end

      it "it creates the file" do
        expect(File).to exist(path)
      end

      it "is marked updated by last action" do
        expect(resource).to be_updated_by_last_action
      end
    end

    context "and the target file exists and has the correct content" do
      before(:each) do
        File.open(path, "w") { |f| f.print expected_content }

        @expected_checksum = sha256_checksum(path)

        now = Time.now.to_i
        File.utime(now - 9000, now - 9000, path)
        @expected_mtime = File.stat(path).mtime

        resource.run_action(:touch)
      end

      it "updates the mtime of the file" do
        expect(File.stat(path).mtime).to be > @expected_mtime
      end

      it "does not change the content" do
        expect(sha256_checksum(path)).to eq(@expected_checksum)
      end

      it "is marked as updated by last action" do
        expect(resource).to be_updated_by_last_action
      end
    end
  end
end