bolt 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd168415311b9cd4c08f4bbd2a22df94d9ba2f513fa989868507118065720ce8
-  data.tar.gz: c5504e881412f51be3a583bb8d091370e4b571ef1a3ed46bca436e433d98fc96
+  metadata.gz: 5e9fd995a1caaab8cc183d8e20404f29ac10509586099832df91ddb45829aed5
+  data.tar.gz: d45036383b14dbc2df9cedccf2bc9a669febab613161e37ef680228dd42fd50e
 SHA512:
-  metadata.gz: 6934e093666be2c77949a390411237128fd535ac2dbe86435e4a34718eb7f72f39c5ba2412085e02d875daf7b677ffea45acc391bf3a82eb41ad607b8fc8e58e
-  data.tar.gz: e7decf1272c8654b10dbb513a1d89cdb6b49ee90f81e562c9f234d235b75e592c0e8f4d8dcabaf7653d75e9f737eb87cac8f16e68c9453f73651edeecd95f636
+  metadata.gz: 83bedc800fcfb5f1449ed873a189dc32845efa1311670332bcc8ab746ac83c3c5453c8bf1a6e6640a5abaa403bebbdce5d6ff1c26dce3ab28b2a13e49dd2081c
+  data.tar.gz: d7ec493dcc3289ae3fa24b6edf3a663677044929fec82e5d7f7498ab0540c3fb475aa83aa17492afe4a1d544291ec357f4132b79bfe5e10a1d783696c057f0d3

data/lib/bolt/pal.rb

@@ -120,12 +120,12 @@ module Bolt
       r
     end
 
-    def with_bolt_executor(executor, inventory, pdb_client = nil, &block)
+    def with_bolt_executor(executor, inventory, pdb_client = nil, applicator = nil, &block)
       opts = {
         bolt_executor: executor,
         bolt_inventory: inventory,
         bolt_pdb_client: pdb_client,
-        apply_executor: Applicator.new(
+        apply_executor: applicator || Applicator.new(
           inventory,
           executor,
           @modulepath,
@@ -141,8 +141,8 @@ module Bolt
       Puppet.override(opts, &block)
     end
 
-    def in_plan_compiler(executor, inventory, pdb_client)
-      with_bolt_executor(executor, inventory, pdb_client) do
+    def in_plan_compiler(executor, inventory, pdb_client, applicator = nil)
+      with_bolt_executor(executor, inventory, pdb_client, applicator) do
         # TODO: remove this call and see if anything breaks when
         # settings dirs don't actually exist. Plans shouldn't
         # actually be using them.
@@ -287,8 +287,8 @@ module Bolt
       end
     end
 
-    def run_plan(plan_name, params, executor = nil, inventory = nil, pdb_client = nil)
-      in_plan_compiler(executor, inventory, pdb_client) do |compiler|
+    def run_plan(plan_name, params, executor = nil, inventory = nil, pdb_client = nil, applicator = nil)
+      in_plan_compiler(executor, inventory, pdb_client, applicator) do |compiler|
         r = compiler.call_function('run_plan', plan_name, params.merge('_bolt_api_call' => true))
         Bolt::PlanResult.from_pcore(r, 'success')
       end

data/lib/bolt/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Bolt
-  VERSION = '1.7.0'
+  VERSION = '1.8.0'
 end

data/lib/bolt_server/base_config.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require 'hocon'
+require 'bolt/error'
+
+module BoltServer
+  class BaseConfig
+    def config_keys
+      ['host', 'port', 'ssl-cert', 'ssl-key', 'ssl-ca-cert',
+       'ssl-cipher-suites', 'loglevel', 'logfile', 'whitelist']
+    end
+
+    def env_keys
+      ['ssl-cert', 'ssl-key', 'ssl-ca-cert', 'loglevel']
+    end
+
+    def defaults
+      { 'host' => '127.0.0.1',
+        'loglevel' => 'notice',
+        'ssl-cipher-suites' => ['ECDHE-ECDSA-AES256-GCM-SHA384',
+                                'ECDHE-RSA-AES256-GCM-SHA384',
+                                'ECDHE-ECDSA-CHACHA20-POLY1305',
+                                'ECDHE-RSA-CHACHA20-POLY1305',
+                                'ECDHE-ECDSA-AES128-GCM-SHA256',
+                                'ECDHE-RSA-AES128-GCM-SHA256',
+                                'ECDHE-ECDSA-AES256-SHA384',
+                                'ECDHE-RSA-AES256-SHA384',
+                                'ECDHE-ECDSA-AES128-SHA256',
+                                'ECDHE-RSA-AES128-SHA256'] }
+    end
+
+    def ssl_keys
+      ['ssl-cert', 'ssl-key', 'ssl-ca-cert']
+    end
+
+    def required_keys
+      ssl_keys
+    end
+
+    def service_name
+      raise "Method service_name must be defined in the service class"
+    end
+
+    def initialize(config = nil)
+      @data = defaults
+      @data = @data.merge(config.select { |key, _| config_keys.include?(key) }) if config
+      @config_path = nil
+    end
+
+    def load_file_config(path)
+      @config_path = path
+      begin
+        # This lets us get the actual config values without needing to
+        # know the service name
+        parsed_hocon = Hocon.load(path)[service_name]
+      rescue Hocon::ConfigError => e
+        raise "Hocon data in '#{path}' failed to load.\n Error: '#{e.message}'"
+      rescue Errno::EACCES
+        raise "Your user doesn't have permission to read #{path}"
+      end
+
+      raise "Could not find service config at #{path}" if parsed_hocon.nil?
+
+      parsed_hocon = parsed_hocon.select { |key, _| config_keys.include?(key) }
+
+      @data = @data.merge(parsed_hocon)
+    end
+
+    def load_env_config
+      raise "load_env_config should be defined in the service class"
+    end
+
+    def natural?(num)
+      num.is_a?(Integer) && num.positive?
+    end
+
+    def validate
+      required_keys.each do |k|
+        next unless @data[k].nil?
+        raise Bolt::ValidationError, "You must configure #{k} in #{@config_path}"
+      end
+
+      unless natural?(@data['port'])
+        raise Bolt::ValidationError, "Configured 'port' must be a valid integer greater than 0"
+      end
+      ssl_keys.each do |sk|
+        unless File.file?(@data[sk]) && File.readable?(@data[sk])
+          raise Bolt::ValidationError, "Configured #{sk} must be a valid filepath"
+        end
+      end
+
+      unless @data['ssl-cipher-suites'].is_a?(Array)
+        raise Bolt::ValidationError, "Configured 'ssl-cipher-suites' must be an array of cipher suite names"
+      end
+
+      unless @data['whitelist'].nil? || @data['whitelist'].is_a?(Array)
+        raise Bolt::ValidationError, "Configured 'whitelist' must be an array of names"
+      end
+    end
+
+    def [](key)
+      @data[key]
+    end
+  end
+end

data/lib/bolt_server/config.rb

@@ -1,70 +1,45 @@
 # frozen_string_literal: true
 
 require 'hocon'
+require 'bolt_server/base_config'
 require 'bolt/error'
 
 module BoltServer
-  class Config
-    CONFIG_KEYS = ['host', 'port', 'ssl-cert', 'ssl-key', 'ssl-ca-cert',
-                   'ssl-cipher-suites', 'loglevel', 'logfile', 'whitelist', 'concurrency',
-                   'cache-dir', 'file-server-conn-timeout', 'file-server-uri'].freeze
-
-    ENV_KEYS = ['ssl-cert', 'ssl-key', 'ssl-ca-cert', 'loglevel',
-                'concurrency', 'file-server-conn-timeout', 'file-server-uri'].freeze
-
-    DEFAULTS = {
-      'host' => '127.0.0.1',
-      'port' => 62658,
-      'ssl-cipher-suites' => ['ECDHE-ECDSA-AES256-GCM-SHA384',
-                              'ECDHE-RSA-AES256-GCM-SHA384',
-                              'ECDHE-ECDSA-CHACHA20-POLY1305',
-                              'ECDHE-RSA-CHACHA20-POLY1305',
-                              'ECDHE-ECDSA-AES128-GCM-SHA256',
-                              'ECDHE-RSA-AES128-GCM-SHA256',
-                              'ECDHE-ECDSA-AES256-SHA384',
-                              'ECDHE-RSA-AES256-SHA384',
-                              'ECDHE-ECDSA-AES128-SHA256',
-                              'ECDHE-RSA-AES128-SHA256'],
-      'loglevel' => 'notice',
-      'concurrency' => 100,
-      'cache-dir' => "/opt/puppetlabs/server/data/bolt-server/cache",
-      'file-server-conn-timeout' => 120
-    }.freeze
-
-    CONFIG_KEYS.each do |key|
-      define_method(key.tr('-', '_').to_sym) do
-        @data[key]
-      end
+  class Config < BoltServer::BaseConfig
+    def config_keys
+      super + %w[concurrency cache-dir file-server-conn-timeout file-server-uri]
     end
 
-    def initialize(config = nil)
-      @data = DEFAULTS.clone
-      @data = @data.merge(config.select { |key, _| CONFIG_KEYS.include?(key) }) if config
-      @config_path = nil
+    def env_keys
+      super + %w[concurrency file-server-conn-timeout file-server-uri]
     end
 
-    def load_file_config(path)
-      @config_path = path
-      begin
-        parsed_hocon = Hocon.load(path)['bolt-server']
-      rescue Hocon::ConfigError => e
-        raise "Hocon data in '#{path}' failed to load.\n Error: '#{e.message}'"
-      rescue Errno::EACCES
-        raise "Your user doesn't have permission to read #{path}"
-      end
+    def int_keys
+      %w[concurrency file-server-conn-timeout]
+    end
 
-      raise "Could not find bolt-server config at #{path}" if parsed_hocon.nil?
+    def defaults
+      super.merge(
+        'port' => 62658,
+        'concurrency' => 100,
+        'cache-dir' => "/opt/puppetlabs/server/data/bolt-server/cache",
+        'file-server-conn-timeout' => 120
+      )
+    end
 
-      parsed_hocon = parsed_hocon.select { |key, _| CONFIG_KEYS.include?(key) }
+    def required_keys
+      super + %w[file-server-uri]
+    end
 
-      @data = @data.merge(parsed_hocon)
+    def service_name
+      'bolt-server'
     end
 
     def load_env_config
-      ENV_KEYS.each do |key|
+      env_keys.each do |key|
         transformed_key = "BOLT_#{key.tr('-', '_').upcase}"
         next unless ENV.key?(transformed_key)
-        @data[key] = if ['concurrency', 'file-server-conn-timeout'].include?(key)
+        @data[key] = if int_keys.include?(key)
                        ENV[transformed_key].to_i
                      else
                        ENV[transformed_key]
@@ -72,47 +47,16 @@ module BoltServer
       end
     end
 
-    def natural?(num)
-      num.is_a?(Integer) && num.positive?
-    end
-
     def validate
-      ssl_keys = ['ssl-cert', 'ssl-key', 'ssl-ca-cert']
-      required_keys = ssl_keys + ['file-server-uri']
+      super
 
-      required_keys.each do |k|
-        next unless @data[k].nil?
-        raise Bolt::ValidationError, "You must configure #{k} in #{@config_path}"
-      end
-
-      unless natural?(port)
-        raise Bolt::ValidationError, "Configured 'port' must be a valid integer greater than 0"
-      end
-      ssl_keys.each do |sk|
-        unless File.file?(@data[sk]) && File.readable?(@data[sk])
-          raise Bolt::ValidationError, "Configured #{sk} must be a valid filepath"
-        end
-      end
-
-      unless ssl_cipher_suites.is_a?(Array)
-        raise Bolt::ValidationError, "Configured 'ssl-cipher-suites' must be an array of cipher suite names"
-      end
-
-      unless whitelist.nil? || whitelist.is_a?(Array)
-        raise Bolt::ValidationError, "Configured 'whitelist' must be an array of names"
-      end
-
-      unless natural?(concurrency)
+      unless natural?(@data['concurrency'])
         raise Bolt::ValidationError, "Configured 'concurrency' must be a positive integer"
       end
 
-      unless natural?(file_server_conn_timeout)
+      unless natural?(@data['file-server-conn-timeout'])
         raise Bolt::ValidationError, "Configured 'file-server-conn-timeout' must be a positive integer"
       end
     end
-
-    def [](key)
-      @data[key]
-    end
   end
 end

data/lib/bolt_server/file_cache.rb

@@ -26,7 +26,7 @@ module BoltServer
                    purge_timeout: PURGE_TIMEOUT,
                    purge_ttl: PURGE_TTL)
       @executor = executor
-      @cache_dir = config.cache_dir
+      @cache_dir = config['cache-dir']
       @config = config
       @logger = Logging.logger[self]
       @cache_dir_mutex = Concurrent::ReadWriteLock.new
@@ -48,30 +48,30 @@ module BoltServer
     end
 
     def ssl_cert
-      @ssl_cert ||= File.read(@config.ssl_cert)
+      @ssl_cert ||= File.read(@config['ssl-cert'])
     end
 
     def ssl_key
-      @ssl_key ||= File.read(@config.ssl_key)
+      @ssl_key ||= File.read(@config['ssl-key'])
     end
 
     def client
       @client ||= begin
-                    uri = URI(@config.file_server_uri)
+                    uri = URI(@config['file-server-uri'])
                     https = Net::HTTP.new(uri.host, uri.port)
                     https.use_ssl = true
                     https.ssl_version = :TLSv1_2
-                    https.ca_file = @config.ssl_ca_cert
+                    https.ca_file = @config['ssl-ca-cert']
                     https.cert = OpenSSL::X509::Certificate.new(ssl_cert)
                     https.key = OpenSSL::PKey::RSA.new(ssl_key)
                     https.verify_mode = OpenSSL::SSL::VERIFY_PEER
-                    https.open_timeout = @config.file_server_conn_timeout
+                    https.open_timeout = @config['file-server-conn-timeout']
                     https
                   end
     end
 
     def request_file(path, params, file)
-      uri = "#{@config.file_server_uri.chomp('/')}#{path}"
+      uri = "#{@config['file-server-uri'].chomp('/')}#{path}"
       uri = URI(uri)
       uri.query = URI.encode_www_form(params)
 

data/lib/plan_executor/app.rb

@@ -7,6 +7,7 @@ require 'bolt/executor'
 require 'bolt/inventory'
 require 'bolt/pal'
 require 'bolt/puppetdb'
+require 'plan_executor/applicator'
 require 'concurrent'
 require 'json'
 require 'json-schema'
@@ -36,6 +37,8 @@ module PlanExecutor
       # TODO: what should max compiles be set to for apply?
       @pal = Bolt::PAL.new(modulepath, nil)
 
+      @applicator = PlanExecutor::Applicator.new(@inventory, @executor, nil)
+
       super(nil)
     end
 
@@ -82,7 +85,7 @@ module PlanExecutor
       # This provides a wait function, which promise doesn't
       result = Concurrent::Future.execute(executor: @worker) do
         # Stores result in result for testing
-        @pal.run_plan(name, params, @executor, @inventory, puppetdb_client)
+        @pal.run_plan(name, params, @executor, @inventory, puppetdb_client, @applicator)
       end
 
       [200, { status: 'running' }.to_json]

data/lib/plan_executor/applicator.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'bolt/error'
+
+module PlanExecutor
+  class Applicator
+    def initialize(inventory, executor, config)
+      @inventory = inventory
+      @executor = executor
+      @config = config
+    end
+
+    def raise_not_implemented(feature)
+      raise Bolt::Error.new("#{feature} not implemented for plan executor service.",
+                            'bolt.plan-executor/not-implemented')
+    end
+
+    def apply(_args, _apply_body, _scope)
+      raise_not_implemented("apply")
+    end
+
+    def build_plugin_tarball
+      raise_not_implemented("build_plugin_tarball")
+    end
+
+    def custom_facts_task
+      raise_not_implemented('custom_facts_task')
+    end
+  end
+end

data/lib/plan_executor/config.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'hocon'
+require 'bolt_server/base_config'
+require 'bolt/error'
+
+module PlanExecutor
+  class Config < BoltServer::BaseConfig
+    def config_keys
+      super + %w[modulepath workers]
+    end
+
+    def defaults
+      super.merge(
+        'port' => 62659,
+        'workers' => 1
+      )
+    end
+
+    def service_name
+      'plan-executor'
+    end
+
+    def load_env_config
+      env_keys.each do |key|
+        transformed_key = "BOLT_#{key.tr('-', '_').upcase}"
+        next unless ENV.key?(transformed_key)
+        @data[key] = ENV[transformed_key]
+      end
+    end
+
+    def validate
+      super
+      unless natural?(@data['workers'])
+        raise Bolt::ValidationError, "Configured 'workers' must be a positive integer"
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bolt
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Puppet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-19 00:00:00.000000000 Z
+date: 2019-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -288,7 +288,6 @@ email:
 executables:
 - bolt
 - bolt-inventory-pdb
-- bolt-server
 extensions: []
 extra_rdoc_files: []
 files:
@@ -319,7 +318,6 @@ files:
 - bolt-modules/boltlib/types/targetspec.pp
 - exe/bolt
 - exe/bolt-inventory-pdb
-- exe/bolt-server
 - lib/bolt.rb
 - lib/bolt/analytics.rb
 - lib/bolt/applicator.rb
@@ -372,6 +370,7 @@ files:
 - lib/bolt/version.rb
 - lib/bolt_ext/puppetdb_inventory.rb
 - lib/bolt_server/acl.rb
+- lib/bolt_server/base_config.rb
 - lib/bolt_server/config.rb
 - lib/bolt_server/file_cache.rb
 - lib/bolt_server/schemas/ssh-run_task.json
@@ -387,6 +386,8 @@ files:
 - lib/bolt_spec/plans/mock_executor.rb
 - lib/bolt_spec/run.rb
 - lib/plan_executor/app.rb
+- lib/plan_executor/applicator.rb
+- lib/plan_executor/config.rb
 - lib/plan_executor/schemas/run_plan.json
 - libexec/apply_catalog.rb
 - libexec/bolt_catalog

data/exe/bolt-server

@@ -1,6 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'puma/cli'
-cli = Puma::CLI.new ARGV
-cli.run