File: data_binding_spec.rb

package info (click to toggle)
puppet-agent 8.10.0-5
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 27,392 kB
  • sloc: ruby: 286,820; sh: 492; xml: 116; makefile: 88; cs: 68
file content (278 lines) | stat: -rw-r--r-- 7,800 bytes parent folder | download | duplicates (3)
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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
require 'spec_helper'
require 'puppet/indirector/hiera'

require 'puppet_spec/compiler'
require 'puppet/indirector/data_binding/hiera'

describe "Data binding" do
  include PuppetSpec::Files
  include PuppetSpec::Compiler

  let(:dir) { tmpdir("puppetdir") }
  let(:data) {{
    'global' => {
      'testing::binding::value' => 'the value',
      'testing::binding::calling_class' => '%{calling_class}',
      'testing::binding::calling_class_path' => '%{calling_class_path}'
    }
  }}
  let(:hash_data) {{
    'global' => {
      'testing::hash::options' => {
        'key'  => 'value',
        'port' => '80',
        'bind' => 'localhost'
      }
    },
    'agent.example.com' => {
      'testing::hash::options' => {
        'key'  => 'new value',
        'port' => '443'
      }
    }
  }}
  let(:hash_data_with_lopts) {{
    'global' => {
      'testing::hash::options' => {
        'key'  => 'value',
        'port' => '80',
        'bind' => 'localhost'
      }
    },
    'agent.example.com' => {
      'lookup_options' => {
        'testing::hash::options' => {
          'merge' => 'deep'
        }
      },
      'testing::hash::options' => {
        'key'  => 'new value',
        'port' => '443'
      }
    }
  }}

  before do
    # Drop all occurances of cached hiera instances. This will reset @hiera in Puppet::Indirector::Hiera, Testing::DataBinding::Hiera,
    # and Puppet::DataBinding::Hiera. Different classes are active as indirection depending on configuration
    ObjectSpace.each_object(Class).select {|klass| klass <= Puppet::Indirector::Hiera }.each { |klass| klass.instance_variable_set(:@hiera, nil) }
    Puppet[:data_binding_terminus] = 'hiera'
    Puppet[:modulepath] = dir
  end

  context "with testing::binding and global data only" do
    it "looks up global data from hiera" do
      configure_hiera_for_one_tier(data)

      create_manifest_in_module("testing", "binding.pp",
                                <<-MANIFEST)
      class testing::binding($value,
                             $calling_class,
                             $calling_class_path,
                             $calling_module = $module_name) {}
      MANIFEST

      catalog = compile_to_catalog("include testing::binding")
      resource = catalog.resource('Class[testing::binding]')

      expect(resource[:value]).to eq("the value")
      expect(resource[:calling_class]).to eq("testing::binding")
      expect(resource[:calling_class_path]).to eq("testing/binding")
      expect(resource[:calling_module]).to eq("testing")
    end
  end

  context "with testing::hash and global data only" do
    it "looks up global data from hiera" do
      configure_hiera_for_one_tier(hash_data)

      create_manifest_in_module("testing", "hash.pp",
                                <<-MANIFEST)
      class testing::hash($options) {}
      MANIFEST

      catalog = compile_to_catalog("include testing::hash")
      resource = catalog.resource('Class[testing::hash]')

      expect(resource[:options]).to eq({
	'key'  => 'value',
	'port' => '80',
	'bind' => 'localhost'
      })
    end
  end

  context "with custom clientcert" do
    it "merges global data with agent.example.com data from hiera" do
      configure_hiera_for_two_tier(hash_data)

      create_manifest_in_module("testing", "hash.pp",
                                <<-MANIFEST)
      class testing::hash($options) {}
      MANIFEST

      catalog = compile_to_catalog("include testing::hash")
      resource = catalog.resource('Class[testing::hash]')

      expect(resource[:options]).to eq({
            'key'  => 'new value',
            'port' => '443',
      })
    end
  end

  context "with custom clientcert and with lookup_options" do
    it "merges global data with agent.example.com data from hiera" do
      configure_hiera_for_two_tier(hash_data_with_lopts)

      create_manifest_in_module("testing", "hash.pp",
                                <<-MANIFEST)
      class testing::hash($options) {}
      MANIFEST

      catalog = compile_to_catalog("include testing::hash")
      resource = catalog.resource('Class[testing::hash]')

      expect(resource[:options]).to eq({
        'key'  => 'new value',
        'port' => '443',
	      'bind' => 'localhost',
      })
    end
  end

  context "with plan_hierarchy key" do
    context "using Hiera 5" do
      let(:hiera_config) { <<~CONF  }
      ---
      version: 5
      plan_hierarchy:
        - path: global
          name: Common
      CONF

      it "ignores plan_hierarchy outside of a Bolt plan" do
        configure_hiera_for_plan_hierarchy(data, hiera_config)

        create_manifest_in_module("testing", "binding.pp",
                                  <<-MANIFEST)
      class testing::binding($value) {}
        MANIFEST

        expect { compile_to_catalog("include testing::binding") }
          .to raise_error(/Class\[Testing::Binding\]: expects a value for parameter 'value'/)
      end
    end

    context "with invalid data" do
      let(:hiera_config) { <<~CONF  }
      ---
      version: 5
      plan_hierarchy:
        - pop: the question
      CONF

      it "raises a validation error" do
        configure_hiera_for_plan_hierarchy(data, hiera_config)

        create_manifest_in_module("testing", "binding.pp",
                                  <<-MANIFEST)
      class testing::binding($value) {}
        MANIFEST

        expect { compile_to_catalog("include testing::binding") }
          .to raise_error(/entry 'plan_hierarchy' index 0 unrecognized key 'pop'/)
      end
    end

    context "with Hiera 3" do
      let(:hiera_config) { <<~CONF  }
      ---
      plan_hierarchy: ['global']
      CONF

      it "errors with plan_hierarchy key" do
        configure_hiera_for_plan_hierarchy(data, hiera_config)

        create_manifest_in_module("testing", "binding.pp",
                                  <<-MANIFEST)
      class testing::binding($value) {}
        MANIFEST

        expect { compile_to_catalog("include testing::binding") }
          .to raise_error(/unrecognized key 'plan_hierarchy'/)

      end
    end
  end


  def configure_hiera_for_one_tier(data)
    hiera_config_file = tmpfile("hiera.yaml")

    File.open(hiera_config_file, 'w:UTF-8') do |f|
      f.write("---
        :yaml:
          :datadir: #{dir}
        :hierarchy: ['global']
        :logger: 'noop'
        :backends: ['yaml']
      ")
    end

    data.each do | file, contents |
      File.open(File.join(dir, "#{file}.yaml"), 'w:UTF-8') do |f|
        f.write(YAML.dump(contents))
      end
    end

    Puppet[:hiera_config] = hiera_config_file
  end

  def configure_hiera_for_plan_hierarchy(data, config)
    hiera_config_file = tmpfile("hiera.yaml")

    File.open(hiera_config_file, 'w:UTF-8') do |f|
      f.write(config)
    end

    data.each do | file, contents |
      File.open(File.join(dir, "#{file}.yaml"), 'w:UTF-8') do |f|
        f.write(YAML.dump(contents))
      end
    end

    Puppet[:hiera_config] = hiera_config_file
  end

  def configure_hiera_for_two_tier(data)
    hiera_config_file = tmpfile("hiera.yaml")

    File.open(hiera_config_file, 'w:UTF-8') do |f|
      f.write("---
        :yaml:
          :datadir: #{dir}
        :hierarchy: ['agent.example.com', 'global']
        :logger: 'noop'
        :backends: ['yaml']
      ")
    end

    data.each do | file, contents |
      File.open(File.join(dir, "#{file}.yaml"), 'w:UTF-8') do |f|
        f.write(YAML.dump(contents))
      end
    end

    Puppet[:hiera_config] = hiera_config_file
  end

  def create_manifest_in_module(module_name, name, manifest)
    module_dir = File.join(dir, module_name, 'manifests')
    FileUtils.mkdir_p(module_dir)

    File.open(File.join(module_dir, name), 'w:UTF-8') do |f|
      f.write(manifest)
    end
  end
end