bolt 1.28.0 → 1.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2d33a034fb69edd25b761aec5e21075aa9ad9f0ccce67122994a2e24dda01f4
-  data.tar.gz: '0348c1d2ed663a0c3556795017c219a88c4e432788fe10e8d75bb1f03f0eed89'
+  metadata.gz: 8594a6349cae9dc7c45446a40f0f15c7093a2b706361f48a938b6a21471a7ae4
+  data.tar.gz: 0a4954a8df306277da739d1ae33849719f0071db2ef9ba337ca3a7e045a2861f
 SHA512:
-  metadata.gz: b842c4a35c334729e47f361ea5be9a0467934d1afc718cec50d117f6573f1a2024eac84e4049730c02bd6cc97158dadc7c4ce1d6adff207efbdc103ffc4f0560
-  data.tar.gz: 470115a05e6edd058de12934e48e77441105cd83baeadca192d7bf7591b2e5f2bef998164614bee9cbebe0b511fe7507a8dcd61b0fbb19810e75e59bb55c7900
+  metadata.gz: 63d35051226313b40df680787dd026922fc829480e5cc7e73e34f882ab494a0a7bfb746a2cb561c34ad63f35d382226fd165c45783c2249f23e15763065ba07d
+  data.tar.gz: 9702e0fe3b12e5f7b7b5531d4dee87a5bd12a39070946c7ea9da678aa8db5d018195c34a1b7f4109c470ef34d98ec6831167cd254c50375df89a8d6dd0a51cb0

data/lib/bolt/plugin/terraform.rb

@@ -5,6 +5,10 @@ require 'json'
 module Bolt
   class Plugin
     class Terraform
+      KNOWN_KEYS = Set['_plugin', 'dir', 'resource_type', 'uri', 'name', 'statefile',
+                       'config', 'backend']
+      REQ_KEYS = Set['dir', 'resource_type']
+
       def initialize
         @logger = Logging.logger[self]
       end
@@ -21,7 +25,25 @@ module Bolt
         @logger.warn("Could not find property #{property} of terraform resource #{name}")
       end
 
+      # Make sure no unexpected keys are in the inventory config and
+      # that required keys are present
+      def validate_options(opts)
+        opt_keys = opts.keys.to_set
+
+        unless KNOWN_KEYS.superset?(opt_keys)
+          keys = opt_keys - KNOWN_KEYS
+          raise Bolt::ValidationError, "Unexpected key(s) in inventory config: #{keys.to_a.inspect}"
+        end
+
+        unless opt_keys.superset?(REQ_KEYS)
+          keys = REQ_KEYS - opt_keys
+          raise Bolt::ValidationError, "Expected key(s) in inventory config: #{keys.to_a.inspect}"
+        end
+      end
+
       def inventory_targets(opts)
+        validate_options(opts)
+
         state = load_statefile(opts)
 
         resources = extract_resources(state)
@@ -49,11 +71,43 @@ module Bolt
       end
 
       def load_statefile(opts)
+        statefile = if opts['backend'] == 'remote'
+                      load_remote_statefile(opts)
+                    else
+                      load_local_statefile(opts)
+                    end
+
+        JSON.parse(statefile)
+      end
+
+      # Uses the Terraform CLI to pull remote state files
+      def load_remote_statefile(opts)
+        dir = File.expand_path(opts['dir'])
+
+        begin
+          stdout_str, stderr_str, status = Open3.capture3('terraform state pull', chdir: dir)
+        rescue Errno::ENOENT
+          reason = if File.directory?(dir)
+                     "Could not find executable 'terraform'"
+                   else
+                     "Could not find directory '#{dir}'"
+                   end
+          raise Bolt::Error.new(reason, 'FILE_ERROR')
+        end
+
+        unless status.success?
+          err = stdout_str + stderr_str
+          msg = "Could not pull Terraform remote state file for #{opts['dir']}:\n#{err}"
+          raise Bolt::Error.new(msg, 'bolt/terraform-state-error')
+        end
+
+        stdout_str
+      end
+
+      def load_local_statefile(opts)
         dir = opts['dir']
         filename = opts.fetch('statefile', 'terraform.tfstate')
-        statefile = File.expand_path(File.join(dir, filename))
-
-        JSON.parse(File.read(statefile))
+        File.read(File.expand_path(File.join(dir, filename)))
       rescue StandardError => e
         raise Bolt::FileError.new("Could not load Terraform state file #{filename}: #{e}", filename)
       end
@@ -68,8 +122,10 @@ module Bolt
             resource_set['instances'].map do |resource|
               instance_name = prefix
               instance_name += ".#{resource['index_key']}" if resource['index_key']
-
-              [instance_name, resource['attributes']]
+              # When using `terraform state pull` with terraform >= 0.12 version 3 statefiles
+              # Will be converted to version 4. When converted attributes is converted to attributes_flat
+              attributes = resource['attributes'] || resource['attributes_flat']
+              [instance_name, attributes]
             end
           end
         else

data/lib/bolt/transport/local.rb

@@ -12,8 +12,7 @@ module Bolt
       end
 
       def self.validate(options)
-        logger = Logging.logger[self]
-        validate_sudo_options(options, logger)
+        validate_sudo_options(options)
       end
 
       def with_connection(target, *_args)

data/lib/bolt/transport/ssh.rb

@@ -28,8 +28,7 @@ module Bolt
       end
 
       def self.validate(options)
-        logger = Logging.logger[self]
-        validate_sudo_options(options, logger)
+        validate_sudo_options(options)
 
         host_key = options['host-key-check']
         unless !!host_key == host_key

data/lib/bolt/transport/sudoable.rb

@@ -6,12 +6,7 @@ require 'bolt/transport/base'
 module Bolt
   module Transport
     class Sudoable < Base
-      def self.validate_sudo_options(options, logger)
-        if options['sudo-password'] && options['run-as'].nil?
-          logger.warn("--sudo-password will not be used without specifying a " \
-                      "user to escalate to with --run-as")
-        end
-
+      def self.validate_sudo_options(options)
         run_as_cmd = options['run-as-command']
         if run_as_cmd && (!run_as_cmd.is_a?(Array) || run_as_cmd.any? { |n| !n.is_a?(String) })
           raise Bolt::ValidationError, "run-as-command must be an Array of Strings, received #{run_as_cmd}"

data/lib/bolt/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bolt
 version: !ruby/object:Gem::Version
-  version: 1.28.0
+  version: 1.29.0
 platform: ruby
 authors:
 - Puppet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-08 00:00:00.000000000 Z
+date: 2019-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable