kitchen-pulumi 0.1.0.pre.beta → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 364ba19dd3c354faa5da8dced15d5a512ddd5632049a7b833ae9be70988986cc
-  data.tar.gz: 38b0bde440532a316ffeaf1da6fba1556a071d5b3021ed3e10adc90447325862
+  metadata.gz: d6c0ce9de8379c66a261cbc65cf916a72cc46f44b1dd1fa75351807a9a38d828
+  data.tar.gz: 7e346277daebaa03ca622ca61a694004d412d6a0b6f2fc1badea8d8f752b33f9
 SHA512:
-  metadata.gz: 1ddea6c299dfe2537cf3b356af371415bebd01b134abf5f5d7a5ae053fea66f7975fa400914f53d8d8074a571a394829ff3524bc259feed9d9ea0722d3aafa0b
-  data.tar.gz: 362722b88d15305c290f580c3f5363e3b61d1b84bd084ec88dbe59d345111d50151d64e295b585bfc5916fcb33307f8e3033cb0c12f290490644601edca09e56
+  metadata.gz: 88631c7633e26c60539e22deefb778bf44e5f438d2af53101ea5645a02d3633997358ef04747f85f3f12a405ad797e76a96b469eceb262850bd0b4e275eec0d5
+  data.tar.gz: b1ec83259b24dad3c038c77f471655ee34ead9b3478cbf5db9942f5c8db4c264d801fae99e14bc889e9f13a4a0b1d9eaeaebb820a1de779d4b13d1b7f8719fd9

data/README.md

@@ -1,4 +1,73 @@
+# Kitchen-Pulumi
+
+[![Gem](https://img.shields.io/gem/v/kitchen-pulumi.svg)](https://rubygems.org/gems/kitchen-pulumi/)
+[![Gem](https://img.shields.io/gem/dt/kitchen-pulumi.svg)](https://rubygems.org/gems/kitchen-pulumi/)
+[![Gem](https://img.shields.io/gem/dtv/kitchen-pulumi.svg)](https://rubygems.org/gems/kitchen-pulumi/)
 [![CircleCI](https://circleci.com/gh/jacoblearned/kitchen-pulumi/tree/master.svg?style=shield)](https://circleci.com/gh/jacoblearned/kitchen-pulumi/tree/master)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/35afd25bac772504e2a0/test_coverage)](https://codeclimate.com/github/jacoblearned/kitchen-pulumi/test_coverage)
+[![Maintainability](https://api.codeclimate.com/v1/badges/35afd25bac772504e2a0/maintainability)](https://codeclimate.com/github/jacoblearned/kitchen-pulumi/maintainability)
+
+Kitchen-Pulumi is a collection of [Test-Kitchen](https://kitchen.ci/) plugins for developing test-driven [Pulumi](https://www.pulumi.com/)-based cloud infrastructure projects.
+With Kitchen-Pulumi you can provision ephemeral test stacks, verify they are in a desired state using [InSpec](https://www.inspec.io/), and tear them down to gain
+confidence in your infrastructure code before it hits production.
+
+## Features
+
+Kitchen-Pulumi provides a Kitchen [driver](https://kitchen.ci/docs/drivers/), [provisioner](https://kitchen.ci/docs/provisioners/),
+and [verifier](https://kitchen.ci/docs/verifiers/) which collectively support the following features:
+
+* **Language-agnostic**: Create and test Pulumi stacks in any of their [supported languages](https://www.pulumi.com/docs/reference/languages/).
+* **Backend-agnostic**: Use the Pulumi SaaS backend, a local backend, or your organization's internal backend.
+* **Configurable**: Easily define/override stack config values in your `.kitchen.yml` file for flexible testing across environments or scenarios.
+* **Test changes over time**: Simulate changes in stack config values over time to test how your infrastructure reacts to ever-shifting user-provided values.
+* **Custom state verification**: Code any validation logic you desire, provided it can be ran within an [InSpec profile](https://www.inspec.io/docs/reference/profiles/).
+
+If there's a feature you would like to see in Kitchen-Pulumi, please create an issue with the suggested feature and its intended use case.
+
+## Installation
+
+Kitchen-Pulumi is compatible with Ruby 2.6 and above. Add this line to your application's Gemfile:
+
+```ruby
+# Gemfile
+
+gem 'kitchen-pulumi', require: false
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install kitchen-pulumi
+```
+
+## Quick Start / Tutorial
+
+Check out the [serverless-rest-api-lambda example](examples/aws/serverless-rest-api-lambda) and follow the instructions in its `README`.
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are always welcome on GitHub at https://github.com/jacoblearned/kitchen-pulumi. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Kitchen-Pulumi’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/jacoblearned/kitchen-pulumi/blob/master/CODE_OF_CONDUCT.md).
 
-# kitchen-pulumi
-Test-Kitchen plugins for Pulumi projects

data/lib/kitchen/driver/pulumi.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
+require 'yaml'
 require 'kitchen'
 require 'kitchen/driver/base'
 require 'kitchen/pulumi/error'
 require 'kitchen/pulumi/shell_out'
+require 'kitchen/pulumi/deep_merge'
 require 'kitchen/pulumi/configurable'
 require 'kitchen/pulumi/command/input'
 require 'kitchen/pulumi/command/output'
@@ -13,17 +15,25 @@ require 'kitchen/pulumi/config_attribute/directory'
 require 'kitchen/pulumi/config_attribute/plugins'
 require 'kitchen/pulumi/config_attribute/backend'
 require 'kitchen/pulumi/config_attribute/secrets'
-require 'kitchen/pulumi/config_attribute/stack'
+require 'kitchen/pulumi/config_attribute/test_stack_name'
 require 'kitchen/pulumi/config_attribute/stack_evolution'
 require 'kitchen/pulumi/config_attribute/refresh_config'
+require 'kitchen/pulumi/config_attribute/secrets_provider'
+require 'kitchen/pulumi/config_attribute/preserve_config'
 
 module Kitchen
+  # This namespace is defined by Kitchen.
+  #
+  # @see https://www.rubydoc.info/gems/test-kitchen/Kitchen/Driver
   module Driver
     # Driver class implementing the CLI equivalency between Kitchen and Pulumi
+    #
+    # @author Jacob Learned
     class Pulumi < ::Kitchen::Driver::Base
       kitchen_driver_api_version 2
 
       include ::Kitchen::Pulumi::Configurable
+      include ::Kitchen::Logging
 
       # Include config attributes consumable via .kitchen.yml
       include ::Kitchen::Pulumi::ConfigAttribute::Config
@@ -32,47 +42,107 @@ module Kitchen
       include ::Kitchen::Pulumi::ConfigAttribute::Plugins
       include ::Kitchen::Pulumi::ConfigAttribute::Backend
       include ::Kitchen::Pulumi::ConfigAttribute::Secrets
-      include ::Kitchen::Pulumi::ConfigAttribute::Stack
+      include ::Kitchen::Pulumi::ConfigAttribute::TestStackName
       include ::Kitchen::Pulumi::ConfigAttribute::StackEvolution
       include ::Kitchen::Pulumi::ConfigAttribute::RefreshConfig
+      include ::Kitchen::Pulumi::ConfigAttribute::SecretsProvider
+      include ::Kitchen::Pulumi::ConfigAttribute::PreserveConfig
 
+      # Initializes a stack via `pulumi stack init`
+      #
+      # @param _state [::Hash] the current kitchen state
+      # @return [void]
       def create(_state)
         dir = "-C #{config_directory}"
-        stack = config_stack.empty? ? instance.suite.name : config_stack
-        conf_file = config_file
-
         login
         initialize_stack(stack, dir)
-        configure(config_config, stack, dir, conf_file)
-        configure(config_secrets, stack, dir, conf_file, is_secret: true)
       end
 
-      def update(_state)
+      # Sets stack config values via `pulumi config` and updates the stack via `pulumi up`
+      #
+      # @param _state [::Hash] the current kitchen state
+      # @param config_only [Boolean] specify true to update the stack config without
+      #   applying changes to the stack via `pulumi up`
+      #
+      # for block {|temp_conf_file| ...}
+      # @yield [temp_conf_file] provides the path to the temporary config file used
+      #
+      # @return [void]
+      def update(_state, config_only: false)
         dir = "-C #{config_directory}"
-        stack = config_stack.empty? ? instance.suite.name : config_stack
-        conf_file = config_file
 
-        login
-        refresh_config(stack, dir, conf_file) if config_refresh_config
-        update_stack(stack, dir, conf_file)
-        evolve_stack(stack, dir) unless config_stack_evolution.empty?
+        ::Kitchen::Pulumi.with_temp_conf(config_file) do |temp_conf_file|
+          login
+          refresh_config(stack, temp_conf_file, dir) if config_refresh_config
+          configure(config_config, stack, temp_conf_file, dir)
+          configure(config_secrets, stack, temp_conf_file, dir, is_secret: true)
+          update_stack(stack, temp_conf_file, dir) unless config_only
+
+          unless config_stack_evolution.empty?
+            evolve_stack(stack, temp_conf_file, dir, config_only: config_only)
+          end
+
+          yield temp_conf_file if block_given?
+        end
       end
 
+      # Destroys a stack via `pulumi destroy`
+      #
+      # @param _state [::Hash] the current kitchen state
+      # @return [void]
       def destroy(_state)
         dir = "-C #{config_directory}"
-        stack = config_stack.empty? ? instance.suite.name : config_stack
 
         cmds = [
           "destroy -y -r --show-config -s #{stack} #{dir}",
-          "stack rm --preserve-config -y -s #{stack} #{dir}",
+          "stack rm #{preserve_config} -y -s #{stack} #{dir}",
         ]
 
         login
         ::Kitchen::Pulumi::ShellOut.run(cmd: cmds, logger: logger)
       rescue ::Kitchen::Pulumi::Error => e
-        puts 'Continuing...' if e.message.match?(/no stack named '#{stack}' found/)
+        if e.message.match?(/no stack named '#{stack}' found/) || (
+          e.message.match?(/failed to load checkpoint/) && config_backend == 'local'
+        )
+          puts "Stack '#{stack}' does not exist, continuing..."
+        end
+      end
+
+      # Returns `--preserve-config` if the `preserve_config` instance attribute is set
+      #
+      # @return [String] either `''` or `--preserve-config`
+      def preserve_config
+        return '' unless config_preserve_config
+
+        '--preserve-config'
+      end
+
+      # Returns the name of the current stack to use. If the `test_stack_name` driver
+      # attribute is set, then it uses that one, otherwise it will be
+      # `<suite name>-<platform name>`
+      #
+      # @return [String] either the empty string or '--preserve-config'
+      def stack
+        return config_test_stack_name unless config_test_stack_name.empty?
+
+        "#{instance.suite.name}-#{instance.platform.name}"
+      end
+
+      # Returns the name of the secrets provider, if set, optionally as a Pulumi CLI flag
+      #
+      # @param flag [Boolean] specify true to prepend `--secrets-provider=`` to the name
+      # @return [String] value to use for the secrets provider
+      def secrets_provider(flag: false)
+        return '' if config_secrets_provider.empty?
+
+        return "--secrets-provider=\"#{config_secrets_provider}\"" if flag
+
+        config_secrets_provider
       end
 
+      # Logs in to the Pulumi backend set for the instance via `pulumi login`
+      #
+      # @return [void]
       def login
         backend = config_backend == 'local' ? '--local' : config_backend
         ::Kitchen::Pulumi::ShellOut.run(
@@ -81,18 +151,31 @@ module Kitchen
         )
       end
 
+      # Initializes a stack in the current directory unless another is provided
+      #
+      # @param stack [String] name of the stack to initialize
+      # @param dir [String] path to the directory to run Pulumi commands in
       def initialize_stack(stack, dir = '')
         ::Kitchen::Pulumi::ShellOut.run(
-          cmd: "stack init #{stack} #{dir}",
+          cmd: "stack init #{stack} #{dir} #{secrets_provider(flag: true)}",
           logger: logger,
         )
       rescue ::Kitchen::Pulumi::Error => e
         puts 'Continuing...' if e.message.match?(/stack '#{stack}' already exists/)
       end
 
+      # Configures a stack in the current directory unless another is provided
+      #
+      # @param stack_confs [::Hash] hash specifying the stack config for the instance
+      # @param stack [String] name of the stack to configure
+      # @param conf_file [String] path to a stack config file to use for configuration
+      # @param dir [String] path to the directory to run Pulumi commands in
+      # @param is_secret [Boolean] specify true to set the given stack config as secrets
+      # @return [void]
       def configure(stack_confs, stack, conf_file, dir = '', is_secret: false)
         secret = is_secret ? '--secret' : ''
-        base_cmd = "config set #{secret} -s #{stack} #{dir} #{conf_file}"
+        config_flag = config_file(conf_file, flag: true)
+        base_cmd = "config set #{secret} -s #{stack} #{dir} #{config_flag}"
 
         stack_confs.each do |namespace, stack_settings|
           stack_settings.each do |key, val|
@@ -104,59 +187,127 @@ module Kitchen
         end
       end
 
+      # Refreshes a stack's config on the specified config file
+      #
+      # @param stack [String] name of the stack being refreshed
+      # @param conf_file [String] path to a stack config file to use for configuration
+      # @param dir [String] path to the directory to run Pulumi commands in
+      # @return [void]
       def refresh_config(stack, conf_file, dir = '')
         ::Kitchen::Pulumi::ShellOut.run(
-          cmd: "config refresh -s #{stack} #{dir} #{conf_file}",
+          cmd: "config refresh -s #{stack} #{dir} #{config_file(conf_file, flag: true)}",
           logger: logger,
         )
       rescue ::Kitchen::Pulumi::Error => e
         puts 'Continuing...' if e.message.match?(/no previous deployment/)
       end
 
-      def config_file(conf_file = '')
+      # Get the value of the config file to use, if set on instance or provided as param,
+      # optionally as a command line flag `--config-file`
+      #
+      # @param conf_file [String] path to a stack config file to use for configuration
+      # @param flag [Boolean] specify true to prepend '--config-file ' to the config file
+      # @return [String] the path to the config file or its corresponding CLI flag
+      def config_file(conf_file = '', flag: false)
         file = conf_file.empty? ? config_config_file : conf_file
         return '' if File.directory?(file) || file.empty?
 
-        "--config-file #{file}"
+        return "--config-file #{file}" if flag
+
+        file
       end
 
+      # Updates a stack via `pulumi up` according to instance attributes
+      #
+      # @param (see #refresh_config)
+      # @return [void]
       def update_stack(stack, conf_file, dir = '')
+        base_cmd = "up -y -r --show-config -s #{stack} #{dir}"
         ::Kitchen::Pulumi::ShellOut.run(
-          cmd: "up -y -r --show-config -s #{stack} #{dir} #{conf_file}",
+          cmd: "#{base_cmd} #{config_file(conf_file, flag: true)}",
           logger: logger,
         )
       end
 
-      def evolve_stack(stack, dir = '')
+      # Evolves a stack via successive calls to `pulumi config set` and `pulumi up`
+      # according to the `stack_evolution` instance attribute, if set. This permits
+      # testing stack config changes over time.
+      #
+      # @param (see #refresh_config)
+      # @param config_only [Boolean] specify true to prevent running `pulumi up`
+      # @return [void]
+      def evolve_stack(stack, conf_file, dir = '', config_only: false)
         config_stack_evolution.each do |evolution|
-          conf_file = config_file(evolution.fetch(:config_file, ''))
+          new_conf_file = config_file(evolution.fetch(:config_file, ''))
           new_stack_confs = evolution.fetch(:config, {})
           new_stack_secrets = evolution.fetch(:secrets, {})
 
+          rewrite_config_file(new_conf_file, conf_file)
+
           configure(new_stack_confs, stack, conf_file, dir)
           configure(new_stack_secrets, stack, conf_file, dir, is_secret: true)
-          update_stack(stack, conf_file, dir)
+          update_stack(stack, conf_file, dir) unless config_only
         end
       end
 
+      # Rewrites a temporary config file by merging the contents of the new config file
+      # into the old config file. This is used during stack evolution to ensure that
+      # stack config changes for each evolution step are implemented correctly if the
+      # user has provided a new config file to use for a step.
+      #
+      # @param new_conf_file [String] the path to the new config file to use
+      # @param old_conf_file [String] the path to the config file to overwrite
+      # @return [void]
+      def rewrite_config_file(new_conf_file, old_conf_file)
+        return if new_conf_file.empty?
+
+        old_conf = YAML.load_file(old_conf_file)
+        new_conf_file = File.join(config_directory, new_conf_file)
+        return unless File.exist?(new_conf_file)
+
+        new_conf = old_conf.deep_merge(YAML.load_file(new_conf_file))
+        File.write(old_conf_file, new_conf.to_yaml)
+      end
+
+      # Retrieves the fully resolved stack inputs based on the current configuration
+      # of the stack via `pulumi config`
+      #
+      # @param block [Block] block to run with stack inputs yielded to it
+      #
+      # for block {|stack_inputs| ... }
+      # @yield [stack_inputs] yields a hash of stack inputs
+      #
+      # @raise [Kitchen::ActionFailed] if an error occurs retrieving stack inputs
+      # @return [self]
       def stack_inputs(&block)
-        ::Kitchen::Pulumi::Command::Input.run(
-          directory: config_directory,
-          stack: config_stack,
-          conf_file: config_file,
-          logger: logger,
-          &block
-        )
+        update({}, config_only: true) do |temp_conf_file|
+          ::Kitchen::Pulumi::Command::Input.run(
+            directory: config_directory,
+            stack: stack,
+            conf_file: config_file(temp_conf_file, flag: true),
+            logger: logger,
+            &block
+          )
+        end
 
         self
       rescue ::Kitchen::Pulumi::Error => e
         raise ::Kitchen::ActionFailed, e.message
       end
 
+      # Retrieves stack outputs via `pulumi stack output`
+      #
+      # @param block [Block] block to run with stack outputs yielded to it
+      #
+      # for block {|stack_outputs| ... }
+      # @yield [stack_outputs] yields a hash of stack outputs
+      #
+      # @raise [Kitchen::ActionFailed] if an error occurs retrieving stack outputs
+      # @return [self]
       def stack_outputs(&block)
         ::Kitchen::Pulumi::Command::Output.run(
           directory: config_directory,
-          stack: config_stack,
+          stack: stack,
           logger: logger,
           &block
         )
@@ -165,6 +316,14 @@ module Kitchen
       rescue ::Kitchen::Pulumi::Error => e
         raise ::Kitchen::ActionFailed, e.message
       end
+
+      private
+
+      # @return [Logger] the common logger
+      # @api private
+      def logger
+        Kitchen.logger
+      end
     end
   end
 end

data/lib/kitchen/provisioner/pulumi.rb

@@ -5,15 +5,25 @@ require 'kitchen/provisioner/base'
 require 'kitchen/pulumi/configurable'
 
 module Kitchen
+  # This namespace is defined by Kitchen.
+  #
+  # @see https://www.rubydoc.info/gems/test-kitchen/Kitchen/Provisioner
   module Provisioner
-    # Driver class whose call method is invoked when users
-    # run kitchen converge
+    # Provisioner class whose call method is invoked when users
+    # run `kitchen converge`
+    #
+    # @author Jacob Learned
     class Pulumi < ::Kitchen::Provisioner::Base
       kitchen_provisioner_api_version 2
 
       include ::Kitchen::Pulumi::Configurable
 
-      # Runs stack updates via the instance driver
+      # Runs stack updates via the instance driver which shells out
+      #   to `pulumi up`
+      #
+      # @param state [::Hash] the current kitchen state
+      # @raise [Kitchen::ActionFailed] if an error occurs during update
+      # @return void
       def call(state)
         instance.driver.update(state)
       rescue ::Kitchen::Pulumi::Error => e

data/lib/kitchen/pulumi.rb

@@ -1,8 +1,33 @@
 # frozen_string_literal: true
 
+require 'tempfile'
+
 # Global kitchen module
 module Kitchen
   # Namespace for Kitchen-Pulumi logic
+  # @author Jacob Learned
   module Pulumi
+    # Copies the contents of the given config file to a temporary file and yields the
+    #   path of the temporary file to the block given
+    #
+    # @param config_file [String] the path to the config file to copy into the temp file
+    #
+    # for block {|temp_conf| ... }
+    # @yield [temp_conf] gives the path to the temporary config file
+    def self.with_temp_conf(config_file = '')
+      temp_conf = Tempfile.new(['kitchen-pulumi', '.yaml'])
+
+      if config_file.empty?
+        yield('') if block_given?
+      else
+        begin
+          IO.copy_stream(config_file, temp_conf.path)
+          yield(temp_conf.path) if block_given?
+        ensure
+          temp_conf.close
+          temp_conf.unlink
+        end
+      end
+    end
   end
 end

data/lib/kitchen/pulumi/config_attribute/backend.rb

@@ -26,7 +26,7 @@ module Kitchen
         extend ConfigAttributeCacher
 
         def config_backend_default_value
-          ''
+          'https://api.pulumi.com'
         end
       end
     end

data/lib/kitchen/pulumi/config_attribute/preserve_config.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'kitchen/pulumi'
+require 'kitchen/pulumi/config_schemas/boolean'
+require 'kitchen/pulumi/config_attribute_cacher'
+require 'kitchen/pulumi/config_attribute_definer'
+
+module Kitchen
+  module Pulumi
+    module ConfigAttribute
+      # Attribute used to determine if the stack config should be
+      # preserved after stack is removed with `pulumi stack rm`
+      # during destroy.
+      module PreserveConfig
+        def self.included(plugin_class)
+          definer = ConfigAttributeDefiner.new(
+            attribute: self,
+            schema: ConfigSchemas::Boolean,
+          )
+          definer.define(plugin_class: plugin_class)
+        end
+
+        def self.to_sym
+          :preserve_config
+        end
+
+        extend ConfigAttributeCacher
+
+        def config_preserve_config_default_value
+          false
+        end
+      end
+    end
+  end
+end

data/lib/kitchen/pulumi/config_attribute/{stack.rb → secrets_provider.rb}

@@ -8,8 +8,8 @@ require 'kitchen/pulumi/config_attribute_definer'
 module Kitchen
   module Pulumi
     module ConfigAttribute
-      # Attribute used to specify the stack to use for a specific instance
-      module Stack
+      # Attribute used to specify the secrets provider a stack should use
+      module SecretsProvider
         def self.included(plugin_class)
           definer = ConfigAttributeDefiner.new(
             attribute: self,
@@ -19,12 +19,12 @@ module Kitchen
         end
 
         def self.to_sym
-          :stack
+          :secrets_provider
         end
 
         extend ConfigAttributeCacher
 
-        def config_stack_default_value
+        def config_secrets_provider_default_value
           ''
         end
       end

data/lib/kitchen/pulumi/config_attribute/test_stack_name.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'kitchen/pulumi'
+require 'kitchen/pulumi/config_schemas/string'
+require 'kitchen/pulumi/config_attribute_cacher'
+require 'kitchen/pulumi/config_attribute_definer'
+
+module Kitchen
+  module Pulumi
+    module ConfigAttribute
+      # Attribute used to override the stack name to use for the stack
+      # created for an instance.
+      module TestStackName
+        def self.included(plugin_class)
+          definer = ConfigAttributeDefiner.new(
+            attribute: self,
+            schema: ConfigSchemas::String,
+          )
+          definer.define(plugin_class: plugin_class)
+        end
+
+        def self.to_sym
+          :test_stack_name
+        end
+
+        extend ConfigAttributeCacher
+
+        def config_test_stack_name_default_value
+          ''
+        end
+      end
+    end
+  end
+end

data/lib/kitchen/pulumi/config_schemas/system.rb

@@ -3,7 +3,7 @@
 require 'dry/validation'
 require 'kitchen/pulumi/config_schemas'
 
-# rubocop:disable Metrics/LineLength
+# rubocop:disable Layout/LineLength
 # rubocop:disable Metrics/BlockLength
 module Kitchen
   module Pulumi
@@ -574,4 +574,4 @@ module Kitchen
   end
 end
 # rubocop:enable Metrics/BlockLength
-# rubocop:enable Metrics/LineLength
+# rubocop:enable Layout/LineLength

data/lib/kitchen/pulumi/deep_merge.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+class ::Hash
+  def deep_merge(second)
+    merger = proc { |_key, v1, v2| Hash === v1 && Hash === v2 ? v1.merge(v2, &merger) : Array === v1 && Array === v2 ? v1 | v2 : [:undefined, nil, :nil].include?(v2) ? v1 : v2 }
+    merge(second.to_h, &merger)
+  end
+end

data/lib/kitchen/pulumi/inspec_options_mapper.rb

@@ -62,7 +62,7 @@ module Kitchen
       attr_accessor :system_attributes_to_options
 
       def initialize
-        self.system_attributes_to_options = ::Kitchen::Pulumi::InSpecOptionsMapper::SYSTEM_ATTRIBUTES_TO_OPTIONS.dup # rubocop:disable Metrics/LineLength
+        self.system_attributes_to_options = ::Kitchen::Pulumi::InSpecOptionsMapper::SYSTEM_ATTRIBUTES_TO_OPTIONS.dup # rubocop:disable Layout/LineLength
       end
     end
   end

data/lib/kitchen/pulumi/shell_out.rb

@@ -9,7 +9,7 @@ module Kitchen
     # Module orchestrating calls to the Pulumi CLI
     module ShellOut
       # Shells out to the Pulumi CLI
-      def self.run(cmd:, duration: 7200, logger:, &block)
+      def self.run(cmd:, logger:, duration: 7200, &block)
         cmds = Array(cmd)
         block ||= ->(stdout) { stdout }
         shell_out(commands: cmds, duration: duration, logger: logger, &block)
@@ -20,7 +20,7 @@ module Kitchen
         raise(::Kitchen::Pulumi::Error, "Error: #{e.message}")
       end
 
-      def self.shell_out(commands:, duration: 7200, logger:)
+      def self.shell_out(commands:, logger:, duration: 7200)
         commands.each do |command|
           shell_out = ::Mixlib::ShellOut.new(
             "pulumi #{command}",

data/lib/kitchen/pulumi/system_attrs_resolver.rb

@@ -38,19 +38,15 @@ module Kitchen
       # @param inputs [#to_hash] the config inputs provided to a stack
       # @param outputs [#to_hash] the outputs of the Pulumi stack under test.
       def initialize(inputs:, outputs:)
-        @inputs = inputs.map do |key, value|
-          [key, value.fetch('value', nil)]
-        end.to_h
-        @inputs.merge!(@inputs.map do |key, value|
-          ["input_#{key}", value]
-        end.to_h)
+        @inputs = inputs.transform_values do |value|
+          value.fetch('value', nil)
+        end
+        @inputs.merge!(@inputs.transform_keys { |key| "input_#{key}" })
 
         @outputs = Hash[outputs].map do |key, value|
           [key, value]
         end.to_h
-        @outputs.merge!(@outputs.map do |key, value|
-          ["output_#{key}", value]
-        end.to_h)
+        @outputs.merge!(@outputs.transform_keys { |key| "output_#{key}" })
       rescue ::KeyError => e
         raise ::Kitchen::Pulumi::Error, "System attrs resolution failed\n#{e}"
       end

data/lib/kitchen/pulumi/version.rb

@@ -2,4 +2,4 @@
 
 require 'kitchen/pulumi'
 
-::Kitchen::Pulumi::VERSION = '0.1.0.pre.beta'
+::Kitchen::Pulumi::VERSION = '0.1.0'

data/lib/kitchen/verifier/pulumi.rb

@@ -13,7 +13,7 @@ module Kitchen
   #
   # @see https://www.rubydoc.info/gems/test-kitchen/Kitchen/Verifier
   module Verifier
-    # The verifier utilizes the {https://www.inspec.io/ InSpec infrastructure
+    # The verifier utilizes the {https://www.inspec.io/ InSpec} infrastructure
     # testing framework to verify the behaviour and
     # state of resources in the Pulumi state.
     #
@@ -63,7 +63,7 @@ module Kitchen
     # :reek:MissingSafeMethod {
     #  exclude: [ finalize_config!, load_needed_dependencies! ]
     # }
-    class Pulumi
+    class Pulumi < ::Kitchen::Verifier::Base
       include ::Kitchen::Configurable
       include ::Kitchen::Logging
       include ::Kitchen::Pulumi::ConfigAttribute::Color
@@ -75,7 +75,7 @@ module Kitchen
       attr_reader :inputs, :outputs
 
       def initialize(configuration = {})
-        init_config configuration
+        super(configuration)
         self.inspec_options_mapper = ::Kitchen::Pulumi::InSpecOptionsMapper.new
         self.error_messages = []
         self.inputs = {}
@@ -100,7 +100,7 @@ module Kitchen
         raise ::Kitchen::ActionFailed, e.message
       end
 
-      # doctor checks the system and configuration for common errors.
+      # Checks the system and configuration for common errors.
       #
       # @param _kitchen_state [::Hash] the mutable Kitchen instance state.
       # @return [Boolean] false
@@ -114,6 +114,10 @@ module Kitchen
       attr_accessor :inspec_options_mapper, :error_messages
       attr_writer :inputs, :outputs
 
+      # Raises an error immediately if the `fail_fast` config attribute is set on the
+      #   or collects all errors until execution has ended verifier
+      #
+      # @return [void]
       def handle_error(message:)
         raise ::Kitchen::Pulumi::Error, message if config_fail_fast
 
@@ -121,6 +125,10 @@ module Kitchen
         error_messages.push message
       end
 
+      # Populates the `stack_inputs` and `stack_outputs` with the fully resolved stack
+      #   inputs and outputs produced by the appropriate Pulumi commands
+      #
+      # @return [void]
       def load_variables
         instance.driver.stack_outputs do |outputs:|
           self.outputs.replace(outputs)
@@ -151,6 +159,10 @@ module Kitchen
         )
       end
 
+      # Runs verification logic of the given system
+      #
+      # @param system [::Hash] the system to verify
+      # @return [void]
       def verify(system:)
         ::Kitchen::Pulumi::System.new(
           mapping: {
@@ -167,6 +179,10 @@ module Kitchen
         handle_error message: e.message
       end
 
+      # Runs verification logic for each system defined on the verifier's `systems` config
+      #   attribute
+      #
+      # @return [void]
       def verify_systems
         config_systems.each do |system|
           verify system: system

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-pulumi
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.beta
+  version: 0.1.0
 platform: ruby
 authors:
 - Jacob Learned
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-21 00:00:00.000000000 Z
+date: 2021-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard
@@ -44,42 +44,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.13'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '3.8'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -128,14 +128,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.67'
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.67'
+        version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: logger
   requirement: !ruby/object:Gem::Requirement
@@ -182,44 +238,62 @@ dependencies:
   name: inspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: '2.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: '2.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: mixlib-shellout
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: test-kitchen
   requirement: !ruby/object:Gem::Requirement
@@ -243,7 +317,7 @@ dependencies:
 description: 'Kitchen-Pulumi makes it easy to add integration tests to Pulumi-based
   infrastructure projects.
 
-  '
+'
 email:
 - jacobmlearned@gmail.com
 executables: []
@@ -266,11 +340,13 @@ files:
 - lib/kitchen/pulumi/config_attribute/directory.rb
 - lib/kitchen/pulumi/config_attribute/fail_fast.rb
 - lib/kitchen/pulumi/config_attribute/plugins.rb
+- lib/kitchen/pulumi/config_attribute/preserve_config.rb
 - lib/kitchen/pulumi/config_attribute/refresh_config.rb
 - lib/kitchen/pulumi/config_attribute/secrets.rb
-- lib/kitchen/pulumi/config_attribute/stack.rb
+- lib/kitchen/pulumi/config_attribute/secrets_provider.rb
 - lib/kitchen/pulumi/config_attribute/stack_evolution.rb
 - lib/kitchen/pulumi/config_attribute/systems.rb
+- lib/kitchen/pulumi/config_attribute/test_stack_name.rb
 - lib/kitchen/pulumi/config_attribute_cacher.rb
 - lib/kitchen/pulumi/config_attribute_definer.rb
 - lib/kitchen/pulumi/config_schemas.rb
@@ -284,6 +360,7 @@ files:
 - lib/kitchen/pulumi/config_schemas/system.rb
 - lib/kitchen/pulumi/config_schemas/systems.rb
 - lib/kitchen/pulumi/configurable.rb
+- lib/kitchen/pulumi/deep_merge.rb
 - lib/kitchen/pulumi/error.rb
 - lib/kitchen/pulumi/file_path_config_attribute_definer.rb
 - lib/kitchen/pulumi/inspec.rb
@@ -300,7 +377,8 @@ files:
 homepage: https://github.com/jacoblearned/kitchen-pulumi
 licenses:
 - MIT
-metadata: {}
+metadata:
+  yard.run: yri
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -309,14 +387,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Test-Kitchen plugins for Pulumi projects