summaryrefslogtreecommitdiff
path: root/chef/spec/support/shared/functional/file_resource.rb
blob: 631a5ed7427972c60ad5f7dd70a20bca492d1ef2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
#
# Author:: Seth Chisamore (<schisamo@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.
#

shared_examples_for "a file with the wrong content" do
  it "overwrites the file with the updated content when the :create action is run" do
    Chef::Config[:file_backup_path] = CHEF_SPEC_BACKUP_PATH
    sleep 1
    resource.run_action(:create)
    File.stat(path).mtime.should > @expected_mtime
    sha256_checksum(path).should_not == @expected_checksum
  end

  it "doesn't overwrite the file when the :create_if_missing action is run" do
    sleep 1
    resource.run_action(:create_if_missing)
    File.stat(path).mtime.should == @expected_mtime
    sha256_checksum(path).should == @expected_checksum
  end

  it "should backup the existing file" do
    Chef::Config[:file_backup_path] = CHEF_SPEC_BACKUP_PATH
    resource.run_action(:create)
    Dir.glob(backup_glob).size.should equal(1)
  end

  it "should not attempt to backup the existing file if :backup == 0" do
    Chef::Config[:file_backup_path] = CHEF_SPEC_BACKUP_PATH
    resource.backup(0)
    resource.run_action(:create)
    Dir.glob(backup_glob).size.should equal(0)
  end

  it "deletes the file when the :delete action is run" do
    resource.run_action(:delete)
    File.should_not exist(path)
  end
end

shared_examples_for "a file with the correct content" do
  it "does not overwrite the original when the :create action is run" do
    resource.run_action(:create)
    sha256_checksum(path).should == @expected_checksum
  end

  it "does not update the mtime/atime of the file when the :create action is run" do
    sleep 1
    File.stat(path).mtime.should == @expected_mtime
    File.stat(path).atime.should be_within(2).of(@expected_atime)
  end

  it "doesn't overwrite the file when the :create_if_missing action is run" do
    resource.run_action(:create_if_missing)
    sha256_checksum(path).should == @expected_checksum
  end

  it "deletes the file when the :delete action is run" do
    resource.run_action(:delete)
    File.should_not exist(path)
  end
end

shared_examples_for "a file resource" do
   # note the stripping of the drive letter from the tmpdir on windows
  let(:backup_glob) { File.join(CHEF_SPEC_BACKUP_PATH, Dir.tmpdir.sub(/^([A-Za-z]:)/, ""), "#{file_base}*") }

  context "when the target file does not exist" do
    it "creates the file when the :create action is run" do
      resource.run_action(:create)
      File.should exist(path)
    end

    it "creates the file with the correct content when the :create action is run" do
      resource.run_action(:create)
      IO.read(path).should == expected_content
    end

    it "creates the file with the correct content when the :create_if_missing action is run" do
      resource.run_action(:create_if_missing)
      IO.read(path).should == expected_content
    end

    it "deletes the file when the :delete action is run" do
      resource.run_action(:delete)
      File.should_not exist(path)
    end
  end

  # Set up the context for security tests
  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


  context "when the target file has the wrong content" do
    before(:each) do
      File.open(path, "w") { |f| f.print "This is so wrong!!!" }
      @expected_mtime = File.stat(path).mtime
      @expected_checksum = sha256_checksum(path)
    end

    describe "and the target file has the correct permissions" do
      include_context "setup correct permissions"

      it_behaves_like "a file with the wrong content"

      it_behaves_like "a securable resource"
    end

    context "and the target file has incorrect permissions" do
      include_context "setup broken permissions"

      it_behaves_like "a file with the wrong content"
  
      it_behaves_like "a securable resource"
    end
  end

  context "when the target file has the correct content" do
    before(:each) do
      File.open(path, "w") { |f| f.print expected_content }
      @expected_mtime = File.stat(path).mtime
      @expected_atime = File.stat(path).atime
      @expected_checksum = sha256_checksum(path)
    end

    describe "and the target file has the correct permissions" do
      include_context "setup correct permissions"

      it_behaves_like "a file with the correct content"

      it_behaves_like "a securable resource"
    end

    context "and the target file has incorrect permissions" do
      include_context "setup broken permissions"

      it_behaves_like "a file with the correct content"
  
      it_behaves_like "a securable resource"
    end
  end

end

shared_context Chef::Resource::File  do
  let(:path) do
    File.join(Dir.tmpdir, make_tmpname(file_base, nil))
  end

  after(:each) do
    FileUtils.rm_r(path) if File.exists?(path)
    FileUtils.rm_r(CHEF_SPEC_BACKUP_PATH) if File.exists?(CHEF_SPEC_BACKUP_PATH)
  end
end