Skip to content

Commit 05139bb

Browse files
ekohlekohl
committed
Rewrite loadjson to use the modern function API
This also resolves a bug where JSON.parse returned a StringIO. To properly catch this, the tests are rewritten to avoid mocking where possible. Exceptions are with external URLs and where a failure is expected.
1 parent d871c4d commit 05139bb

File tree

4 files changed

+130
-184
lines changed

4 files changed

+130
-184
lines changed

‎lib/puppet/functions/loadjson.rb‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# frozen_string_literal: true
2+
3+
# @summary DEPRECATED. Use the namespaced function [`stdlib::loadjson`](#stdlibloadjson) instead.
4+
Puppet::Functions.create_function(:loadjson, Puppet::Functions::InternalFunction) do
5+
dispatch :deprecation_gen do
6+
scope_param
7+
repeated_param 'Any', :args
8+
end
9+
def deprecation_gen(scope, *args)
10+
call_function('deprecation', 'loadjson', 'This function is deprecated, please use stdlib::loadjson instead.', false)
11+
scope.call_function('stdlib::loadjson', args)
12+
end
13+
end

‎lib/puppet/functions/stdlib/loadjson.rb‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# frozen_string_literal: true
2+
3+
# @summary
4+
# Load a JSON file containing an array, string, or hash, and return the data
5+
# in the corresponding native data type.
6+
#
7+
# @example Example Usage:
8+
# $myhash = loadjson('/etc/puppet/data/myhash.json')
9+
# $myhash = loadjson('https://example.local/my_hash.json')
10+
# $myhash = loadjson('https://username:[email protected]/my_hash.json')
11+
# $myhash = loadjson('no-file.json', {'default' => 'value'})
12+
Puppet::Functions.create_function(:'stdlib::loadjson') do
13+
# @param path
14+
# A file path or a URL.
15+
# @param default
16+
# The default value to be returned if the file was not found or could not
17+
# be parsed.
18+
#
19+
# @return
20+
# The data stored in the JSON file, the type depending on the type of data
21+
# that was stored.
22+
dispatch :loadjson do
23+
param 'String[1]', :path
24+
optional_param 'Data', :default
25+
return_type 'Data'
26+
end
27+
28+
def loadjson(path, default = nil)
29+
if path.start_with?('http://', 'https://')
30+
require 'uri'
31+
require 'open-uri'
32+
uri = URI.parse(path)
33+
options = {}
34+
if uri.user
35+
options[:http_basic_authentication] = [uri.user, uri.password]
36+
uri.user = nil
37+
end
38+
39+
begin
40+
content = uri.open(**options) { |f| load_json_source(f) }
41+
rescue OpenURI::HTTPError => e
42+
Puppet.warn("Can't load '#{url}' HTTP Error Code: '#{e.io.status[0]}'")
43+
return default
44+
end
45+
elsif File.exist?(path)
46+
content = File.open(path) { |f| load_json_source(f) }
47+
else
48+
Puppet.warn("Can't load '#{path}' File does not exist!")
49+
return default
50+
end
51+
52+
content || default
53+
rescue StandardError => e
54+
raise e unless default
55+
56+
default
57+
end
58+
59+
def load_json_source(source)
60+
if Puppet::Util::Package.versioncmp(Puppet.version, '8.0.0').negative?
61+
PSON.load(source)
62+
else
63+
JSON.load(source)
64+
end
65+
end
66+
end

‎lib/puppet/parser/functions/loadjson.rb‎

Lines changed: 0 additions & 75 deletions
This file was deleted.

‎spec/functions/loadjson_spec.rb‎

Lines changed: 51 additions & 109 deletions
Original file line numberDiff line numberDiff line change
@@ -1,178 +1,120 @@
11
# frozen_string_literal: true
22

33
require 'spec_helper'
4+
require 'open-uri'
5+
require 'stringio'
46

5-
describe 'loadjson' do
7+
describe 'stdlib::loadjson' do
68
it { is_expected.not_to be_nil }
7-
it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{wrong number of arguments}i) }
9+
it { is_expected.to run.with_params.and_raise_error(ArgumentError, "'stdlib::loadjson' expects between 1 and 2 arguments, got none") }
810

911
describe 'when calling with valid arguments' do
10-
before :each do
11-
# In Puppet 7, there are two prior calls to File.read prior to the responses we want to mock
12-
allow(File).to receive(:read).with(anything, anything).and_call_original
13-
allow(File).to receive(:read).with(%r{/(stdlib|test)/metadata.json}, encoding: 'utf-8').and_return('{"name": "puppetlabs-stdlib"}')
14-
allow(File).to receive(:read).with(%r{/(stdlib|test)/metadata.json}).and_return('{"name": "puppetlabs-stdlib"}')
15-
# Additional modules used by litmus which are identified while running these dues to being in fixtures
16-
allow(File).to receive(:read).with(%r{/(provision|puppet_agent|facts)/metadata.json}, encoding: 'utf-8')
17-
end
18-
1912
context 'when a non-existing file is specified' do
2013
let(:filename) do
21-
if Puppet::Util::Platform.windows?
22-
'C:/tmp/doesnotexist'
23-
else
24-
'/tmp/doesnotexist'
25-
end
14+
file = Tempfile.create
15+
file.close
16+
File.unlink(file.path)
17+
file.path
2618
end
2719

2820
before(:each) do
29-
allow(File).to receive(:exist?).and_call_original
30-
allow(File).to receive(:exist?).with(filename).and_return(false).once
3121
if Puppet::PUPPETVERSION[0].to_i < 8
3222
allow(PSON).to receive(:load).never # rubocop:disable RSpec/ReceiveNever Switching to not_to receive breaks testing in this case
3323
else
3424
allow(JSON).to receive(:parse).never # rubocop:disable RSpec/ReceiveNever
3525
end
3626
end
3727

38-
it { is_expected.to run.with_params(filename, 'default' => 'value').and_return('default' => 'value') }
39-
it { is_expected.to run.with_params(filename, 'đẽƒằưļŧ' => '٧ẵłựέ').and_return('đẽƒằưļŧ' => '٧ẵłựέ') }
40-
it { is_expected.to run.with_params(filename, 'デフォルト' => '値').and_return('デフォルト' => '値') }
28+
it { is_expected.to run.with_params(filename, {'default' => 'value'}).and_return({'default' => 'value'}) }
29+
it { is_expected.to run.with_params(filename, {'đẽƒằưļŧ' => '٧ẵłựέ'}).and_return({'đẽƒằưļŧ' => '٧ẵłựέ'}) }
30+
it { is_expected.to run.with_params(filename, {'デフォルト' => '値'}).and_return({'デフォルト' => '値'}) }
4131
end
4232

4333
context 'when an existing file is specified' do
44-
let(:filename) do
45-
if Puppet::Util::Platform.windows?
46-
'C:/tmp/doesexist'
47-
else
48-
'/tmp/doesexist'
49-
end
50-
end
5134
let(:data) { { 'key' => 'value', 'ķęŷ' => 'νậŀųề', 'キー' => '値' } }
5235
let(:json) { '{"key":"value", {"ķęŷ":"νậŀųề" }, {"キー":"値" }' }
5336

54-
before(:each) do
55-
allow(File).to receive(:exist?).and_call_original
56-
allow(File).to receive(:exist?).with(filename).and_return(true).once
57-
allow(File).to receive(:read).with(filename).and_return(json).once
58-
allow(File).to receive(:read).with(filename).and_return(json).once
59-
if Puppet::PUPPETVERSION[0].to_i < 8
60-
allow(PSON).to receive(:load).with(json).and_return(data).once
61-
else
62-
allow(JSON).to receive(:parse).with(json).and_return(data).once
37+
it do
38+
Tempfile.new do |file|
39+
file.write(json)
40+
file.flush
41+
42+
is_expected.to run.with_params(file.path).and_return(data)
6343
end
6444
end
65-
66-
it { is_expected.to run.with_params(filename).and_return(data) }
6745
end
6846

6947
context 'when the file could not be parsed' do
70-
let(:filename) do
71-
if Puppet::Util::Platform.windows?
72-
'C:/tmp/doesexist'
73-
else
74-
'/tmp/doesexist'
75-
end
76-
end
7748
let(:json) { '{"key":"value"}' }
7849

79-
before(:each) do
80-
allow(File).to receive(:exist?).and_call_original
81-
allow(File).to receive(:exist?).with(filename).and_return(true).once
82-
allow(File).to receive(:read).with(filename).and_return(json).once
83-
if Puppet::PUPPETVERSION[0].to_i < 8
84-
allow(PSON).to receive(:load).with(json).once.and_raise StandardError, 'Something terrible have happened!'
85-
else
86-
allow(JSON).to receive(:parse).with(json).once.and_raise StandardError, 'Something terrible have happened!'
50+
it do
51+
Tempfile.new do |file|
52+
file.write(json)
53+
file.flush
54+
55+
is_expected.to run.with_params(filename, {'default' => 'value'}).and_return({'default' => 'value'})
8756
end
8857
end
89-
90-
it { is_expected.to run.with_params(filename, 'default' => 'value').and_return('default' => 'value') }
9158
end
9259

93-
context 'when an existing URL is specified' do
60+
context 'when an existing URL with username and password is specified' do
9461
let(:filename) do
95-
'https://example.local/myhash.json'
62+
'https://user1:pass1@example.local/myhash.json'
9663
end
97-
let(:data) { { 'key' => 'value', 'ķęŷ' => 'νậŀųề', 'キー' => '値' } }
98-
let(:json) { '{"key":"value", {"ķęŷ":"νậŀųề" }, {"キー":"値" }' }
9964

100-
it {
101-
expect(OpenURI).to receive(:open_uri).with(filename, {}).and_return(json)
102-
if Puppet::PUPPETVERSION[0].to_i < 8
103-
expect(PSON).to receive(:load).with(json).and_return(data).once
104-
else
105-
expect(JSON).to receive(:parse).with(json).and_return(data).once
106-
end
107-
expect(subject).to run.with_params(filename).and_return(data)
108-
}
109-
end
65+
it do
66+
uri = URI.parse(filename)
67+
allow(URI).to receive(:parse).and_call_original
68+
expect(URI).to receive(:parse).with(filename).and_return(uri)
69+
expect(uri).to receive(:open).with(http_basic_authentication: ['user1', 'pass1']).and_yield(StringIO.new('{"key":"value"}'))
11070

111-
context 'when an existing URL (with username and password) is specified' do
112-
let(:filename) do
113-
'https://user1:[email protected]/myhash.json'
71+
is_expected.to run.with_params(filename).and_return({'key' => 'value'})
72+
expect(uri.user).to be_nil
11473
end
115-
let(:url_no_auth) { 'https://example.local/myhash.json' }
116-
let(:basic_auth) { { http_basic_authentication: ['user1', 'pass1'] } }
117-
let(:data) { { 'key' => 'value', 'ķęŷ' => 'νậŀųề', 'キー' => '値' } }
118-
let(:json) { '{"key":"value", {"ķęŷ":"νậŀųề" }, {"キー":"値" }' }
119-
120-
it {
121-
expect(OpenURI).to receive(:open_uri).with(url_no_auth, basic_auth).and_return(json)
122-
if Puppet::PUPPETVERSION[0].to_i < 8
123-
expect(PSON).to receive(:load).with(json).and_return(data).once
124-
else
125-
expect(JSON).to receive(:parse).with(json).and_return(data).once
126-
end
127-
expect(subject).to run.with_params(filename).and_return(data)
128-
}
12974
end
13075

131-
context 'when an existing URL (with username) is specified' do
76+
context 'when an existing URL is specified' do
13277
let(:filename) do
133-
'https://user1@example.local/myhash.json'
78+
'https://example.com/myhash.json'
13479
end
135-
let(:url_no_auth) { 'https://example.local/myhash.json' }
136-
let(:basic_auth) { { http_basic_authentication: ['user1', ''] } }
13780
let(:data) { { 'key' => 'value', 'ķęŷ' => 'νậŀųề', 'キー' => '値' } }
138-
let(:json) { '{"key":"value", {"ķęŷ":"νậŀųề" }, {"キー":"値" }' }
81+
let(:json) { '{"key":"value", "ķęŷ":"νậŀųề", "キー":"値" }' }
13982

14083
it {
141-
expect(OpenURI).to receive(:open_uri).with(url_no_auth, basic_auth).and_return(json)
142-
if Puppet::PUPPETVERSION[0].to_i < 8
143-
expect(PSON).to receive(:load).with(json).and_return(data).once
144-
else
145-
expect(JSON).to receive(:parse).with(json).and_return(data).once
146-
end
84+
uri = URI.parse(filename)
85+
allow(URI).to receive(:parse).and_call_original
86+
expect(URI).to receive(:parse).with(filename).and_return(uri)
87+
expect(uri).to receive(:open).with(no_args).and_yield(StringIO.new(json))
14788
expect(subject).to run.with_params(filename).and_return(data)
14889
}
14990
end
15091

15192
context 'when the URL output could not be parsed, with default specified' do
15293
let(:filename) do
153-
'https://example.local/myhash.json'
94+
'https://example.com/myhash.json'
15495
end
15596
let(:json) { ',;{"key":"value"}' }
15697

15798
it {
158-
expect(OpenURI).to receive(:open_uri).with(filename, {}).and_return(json)
159-
if Puppet::PUPPETVERSION[0].to_i < 8
160-
expect(PSON).to receive(:load).with(json).once.and_raise StandardError, 'Something terrible have happened!'
161-
else
162-
expect(JSON).to receive(:parse).with(json).once.and_raise StandardError, 'Something terrible have happened!'
163-
end
164-
expect(subject).to run.with_params(filename, 'default' => 'value').and_return('default' => 'value')
99+
uri = URI.parse(filename)
100+
allow(URI).to receive(:parse).and_call_original
101+
expect(URI).to receive(:parse).with(filename).and_return(uri)
102+
expect(uri).to receive(:open).with(no_args).and_yield(StringIO.new(json))
103+
expect(subject).to run.with_params(filename, {'default' => 'value'}).and_return({'default' => 'value'})
165104
}
166105
end
167106

168107
context 'when the URL does not exist, with default specified' do
169108
let(:filename) do
170-
'https://example.local/myhash.json'
109+
'https://example.com/myhash.json'
171110
end
172111

173112
it {
174-
expect(OpenURI).to receive(:open_uri).with(filename, {}).and_raise OpenURI::HTTPError, '404 File not Found'
175-
expect(subject).to run.with_params(filename, 'default' => 'value').and_return('default' => 'value')
113+
uri = URI.parse(filename)
114+
allow(URI).to receive(:parse).and_call_original
115+
expect(URI).to receive(:parse).with(filename).and_return(uri)
116+
expect(uri).to receive(:open).with(no_args).and_raise(OpenURI::HTTPError, '404 File not Found')
117+
expect(subject).to run.with_params(filename, {'default' => 'value'}).and_return({'default' => 'value'})
176118
}
177119
end
178120
end

0 commit comments

Comments
 (0)