Skip to content

Commit e04f7a0

Browse files
committed
(SERVER-2470) list_all_transports implementation for puppetserver
This change implements a `list_all_transports(env)` method that loads all available transports from a specified environment. To test out, run `rake spec_prep` and use the following setup in pry: ``` require 'puppet' require 'puppet/resource_api/transport' require 'puppet/settings' Puppet.initialize_settings Puppet[:modulepath] = 'spec/fixtures/modules' Puppet::ResourceApi::Transport.list_all_transports('production') ```
1 parent 6d77e7d commit e04f7a0

File tree

3 files changed

+56
-0
lines changed

3 files changed

+56
-0
lines changed

lib/puppet/resource_api/transport.rb

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,35 @@ def register(schema)
2020
module_function :register # rubocop:disable Style/AccessModifierDeclarations
2121

2222
# retrieve a Hash of transport schemas, keyed by their name.
23+
# Only already loaded transports are returned.
2324
def list
2425
Marshal.load(Marshal.dump(transports))
2526
end
2627
module_function :list # rubocop:disable Style/AccessModifierDeclarations
2728

29+
# retrieve a Hash of transport schemas, keyed by their name.
30+
# This uses the Puppet autoloader, provide a environment name as `force_environment`
31+
# to choose where to load from.
32+
# @api private
33+
def list_all_transports(force_environment)
34+
env = Puppet.lookup(:environments).get!(force_environment)
35+
Puppet.override({ current_environment: env }, 'current env for list_all_transports') do
36+
load_all_schemas
37+
Marshal.load(Marshal.dump(transports))
38+
end
39+
end
40+
module_function :list_all_transports # rubocop:disable Style/AccessModifierDeclarations
41+
42+
# Loads all schemas using the Puppet Autoloader.
43+
def self.load_all_schemas
44+
require 'puppet'
45+
require 'puppet/settings'
46+
require 'puppet/util/autoload'
47+
@autoloader ||= Puppet::Util::Autoload.new(self, 'puppet/transport/schema')
48+
@autoloader.loadall(Puppet.lookup(:current_environment))
49+
end
50+
private_class_method :load_all_schemas
51+
2852
def connect(name, connection_info)
2953
validate(name, connection_info)
3054
require "puppet/transport/#{name}"
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
require 'spec_helper'
2+
3+
RSpec.describe 'Resource API Transport integration tests:' do
4+
after(:each) do
5+
# reset registered transports between tests to reduce cross-test poisoning
6+
Puppet::ResourceApi::Transport.instance_variable_set(:@transports, nil)
7+
autoloader = Puppet::ResourceApi::Transport.instance_variable_get(:@autoloader)
8+
autoloader.class.loaded.clear
9+
end
10+
11+
describe '#list_all_transports' do
12+
subject(:transports) { Puppet::ResourceApi::Transport.list_all_transports('rp_env') }
13+
14+
it 'can be called twice' do
15+
expect {
16+
Puppet::ResourceApi::Transport.list_all_transports('rp_env')
17+
Puppet::ResourceApi::Transport.list_all_transports('rp_env')
18+
}.not_to raise_error
19+
end
20+
21+
it 'loads all transports' do
22+
expect(transports).to have_key 'test_device'
23+
expect(transports).to have_key 'test_device_sensitive'
24+
expect(transports['test_device']).to be_a Puppet::ResourceApi::TransportSchemaDef
25+
expect(transports['test_device'].definition).to include(name: 'test_device')
26+
end
27+
end
28+
end

spec/spec_helper.rb

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
require 'bundler/setup'
2+
require 'rspec-puppet'
23

34
RSpec.configure do |config|
45
# Enable flags like --only-failures and --next-failure
@@ -14,6 +15,9 @@
1415
# override legacy default from puppetlabs_spec_helper
1516
config.mock_with :rspec
1617

18+
# enable rspec-puppet support everywhere
19+
config.include RSpec::Puppet::Support
20+
1721
# reset the warning suppression count
1822
config.before(:each) do
1923
Puppet::ResourceApi.warning_count = 0

0 commit comments

Comments
 (0)