summaryrefslogtreecommitdiff
path: root/spec/unit/resource/template_spec.rb
blob: 2f8e234c8587832b971aa0d36edd903544fc8805 (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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
#
# Author:: Adam Jacob (<adam@chef.io>)
# Copyright:: Copyright 2008-2017, 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"

describe Chef::Resource::Template do
  let(:resource) { Chef::Resource::Template.new("fakey_fakerton") }

  describe "initialize" do
    it "is a subclass of Chef::Resource::File" do
      expect(resource).to be_a_kind_of(Chef::Resource::File)
    end
  end

  describe "name" do
    it "the path property is the name_property" do
      expect(resource.path).to eql("fakey_fakerton")
    end
  end

  describe "Actions" do
    it "sets the default action as :create" do
      expect(resource.action).to eql([:create])
    end

    it "supports :create, :create_if_missing, :delete, :touch actions" do
      expect { resource.action :create }.not_to raise_error
      expect { resource.action :create_if_missing }.not_to raise_error
      expect { resource.action :delete }.not_to raise_error
      expect { resource.action :touch }.not_to raise_error
    end
  end

  describe "source" do
    it "accepts a string for the template source" do
      resource.source "something"
      expect(resource.source).to eql("something")
    end

    it "has a default based on the param name with .erb appended" do
      expect(resource.source).to eql("fakey_fakerton.erb")
    end

    it "uses only the basename of the file as the default" do
      r = Chef::Resource::Template.new("/tmp/obit/fakey_fakerton")
      expect(r.source).to eql("fakey_fakerton.erb")
    end
  end

  describe "variables" do
    it "accepts a hash for the variable list" do
      resource.variables({ reluctance: :awkward })
      expect(resource.variables).to eq({ reluctance: :awkward })
    end
  end

  describe "cookbook" do
    it "accepts a string for the cookbook name" do
      resource.cookbook("foo")
      expect(resource.cookbook).to eq("foo")
    end

    it "defaults to nil" do
      expect(resource.cookbook).to eq(nil)
    end
  end

  describe "local" do
    it "accepts a boolean for whether a template is local or remote" do
      resource.local(true)
      expect(resource.local).to eq(true)
    end

    it "defaults to false" do
      expect(resource.local).to eq(false)
    end
  end

  describe "when it has a path, owner, group, mode, and checksum" do
    before do
      resource.path("/tmp/foo.txt")
      resource.owner("root")
      resource.group("wheel")
      resource.mode("0644")
      resource.checksum("1" * 64)
    end

    context "on unix", :unix_only do
      it "describes its state" do
        state = resource.state_for_resource_reporter
        expect(state[:owner]).to eq("root")
        expect(state[:group]).to eq("wheel")
        expect(state[:mode]).to eq("0644")
        expect(state[:checksum]).to eq("1" * 64)
      end
    end

    context "on windows", :windows_only do
      # according to Chef::Resource::File, windows state properties are rights + deny_rights
      skip "it describes its state"
    end

    it "returns the file path as its identity" do
      expect(resource.identity).to eq("/tmp/foo.txt")
    end
  end

  describe "defining helper methods" do

    module ExampleHelpers
      def static_example
        "static_example"
      end
    end

    it "collects helper method bodies as blocks" do
      resource.helper(:example_1) { "example_1" }
      resource.helper(:example_2) { "example_2" }
      expect(resource.inline_helper_blocks[:example_1].call).to eq("example_1")
      expect(resource.inline_helper_blocks[:example_2].call).to eq("example_2")
    end

    it "compiles helper methods into a module" do
      resource.helper(:example_1) { "example_1" }
      resource.helper(:example_2) { "example_2" }
      modules = resource.helper_modules
      expect(modules.size).to eq(1)
      o = Object.new
      modules.each { |m| o.extend(m) }
      expect(o.example_1).to eq("example_1")
      expect(o.example_2).to eq("example_2")
    end

    it "compiles helper methods with arguments into a module" do
      resource.helper(:shout, &:upcase)
      modules = resource.helper_modules
      o = Object.new
      modules.each { |m| o.extend(m) }
      expect(o.shout("shout")).to eq("SHOUT")
    end

    it "raises an error when attempting to define a helper method without a method body" do
      expect { resource.helper(:example) }.to raise_error(Chef::Exceptions::ValidationFailed)
    end

    it "raises an error when attempting to define a helper method with a non-Symbod method name" do
      expect { resource.helper("example") { "fail" } }.to raise_error(Chef::Exceptions::ValidationFailed)
    end

    it "collects helper module bodies as blocks" do
      resource.helpers do
        def example_1
          "example_1"
        end
      end
      module_body = resource.inline_helper_modules.first
      expect(module_body).to be_a(Proc)
    end

    it "compiles helper module bodies into modules" do
      resource.helpers do
        def example_1
          "example_1"
        end
      end
      modules = resource.helper_modules
      expect(modules.size).to eq(1)
      o = Object.new
      modules.each { |m| o.extend(m) }
      expect(o.example_1).to eq("example_1")
    end

    it "raises an error when no block or module name is given for helpers definition" do
      expect { resource.helpers }.to raise_error(Chef::Exceptions::ValidationFailed)
    end

    it "raises an error when a non-module is given for helpers definition" do
      expect { resource.helpers("NotAModule") }.to raise_error(Chef::Exceptions::ValidationFailed)
    end

    it "raises an error when a module name and block are both given for helpers definition" do
      expect { resource.helpers(ExampleHelpers) { module_code } }.to raise_error(Chef::Exceptions::ValidationFailed)
    end

    it "collects helper modules" do
      resource.helpers(ExampleHelpers)
      expect(resource.helper_modules).to include(ExampleHelpers)
    end

    it "combines all helpers into a set of compiled modules" do
      resource.helpers(ExampleHelpers)
      resource.helpers do
        def inline_module
          "inline_module"
        end
      end
      resource.helper(:inline_method) { "inline_method" }
      expect(resource.helper_modules.size).to eq(3)

      o = Object.new
      resource.helper_modules.each { |m| o.extend(m) }
      expect(o.static_example).to eq("static_example")
      expect(o.inline_module).to eq("inline_module")
      expect(o.inline_method).to eq("inline_method")
    end
  end
end