kitchen-pulumi 0.1.0.pre.beta

data/lib/kitchen/pulumi/system_attrs_resolver.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'kitchen/pulumi'
+require 'kitchen/pulumi/error'
+
+module Kitchen
+  module Pulumi
+    # SystemAttrsResolver is the class of objects which resolve for systems the
+    # attrs which are contained in outputs.
+    class SystemAttrsResolver
+      # #resolve resolves the attrs.
+      #
+      # @param attrs_outputs_keys [::Array<::String>] the names of the InSpec
+      #   attributes.
+      # @param attrs_outputs_values [::Array<::String>] the names of the Pulumi
+      #   outputs.
+      # @param system [::Kitchen::Pulumi::System] the system.
+      # @raise [::Kitchen::Pulumi::Error] if the fetching the value of the
+      #   output fails.
+      def resolve(attrs_outputs_keys:, attrs_outputs_values:, system:)
+        system.add_attrs(attrs: @inputs.merge(
+          @outputs.merge(
+            attrs_outputs_keys.lazy.map(&:to_s).zip(
+              @outputs.fetch_values(*attrs_outputs_values),
+            ).to_h,
+          ),
+        ))
+
+        self
+      rescue ::KeyError => e
+        raise ::Kitchen::Pulumi::Error, "Resolving attrs failed\n#{e}"
+      end
+
+      private
+
+      # #initialize prepares the instance to be used.
+      #
+      # @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)
+
+        @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)
+      rescue ::KeyError => e
+        raise ::Kitchen::Pulumi::Error, "System attrs resolution failed\n#{e}"
+      end
+    end
+  end
+end

data/lib/kitchen/pulumi/system_hosts_resolver.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'kitchen/pulumi'
+require 'kitchen/pulumi/error'
+
+module Kitchen
+  module Pulumi
+    # SystemHostsResolver is the class of objects which resolve for systems the
+    # hosts which are contained in outputs.
+    class SystemHostsResolver
+      # #resolve resolves the hosts.
+      #
+      # @param hosts_output [::String] the name of the Pulumi output which has
+      #   a value of hosts for the system.
+      # @param system [::Kitchen::Pulumi::System] the system.
+      # @raise [::Kitchen::Pulumi::Error] if the fetching the value of the
+      #   output fails.
+      def resolve(hosts_output:, system:)
+        system.add_hosts hosts: @outputs.fetch(hosts_output)
+      rescue ::KeyError => e
+        raise ::Kitchen::Pulumi::Error, "Resolving hosts failed\n#{e}"
+      end
+
+      private
+
+      # #initialize prepares the instance to be used.
+      #
+      # @param outputs [#to_hash] the outputs of the Pulumi stack under test.
+      def initialize(outputs:)
+        @outputs = Hash[outputs]
+      end
+    end
+  end
+end

data/lib/kitchen/pulumi/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'kitchen/pulumi'
+
+::Kitchen::Pulumi::VERSION = '0.1.0.pre.beta'

data/lib/kitchen/verifier/pulumi.rb

@@ -0,0 +1,177 @@
+# frozen_string_literal: true
+
+require 'kitchen'
+require 'kitchen/pulumi/config_attribute/color'
+require 'kitchen/pulumi/config_attribute/fail_fast'
+require 'kitchen/pulumi/config_attribute/systems'
+require 'kitchen/pulumi/configurable'
+require 'kitchen/pulumi/error'
+require 'kitchen/pulumi/inspec_options_mapper'
+
+module Kitchen
+  # This namespace is defined by Kitchen.
+  #
+  # @see https://www.rubydoc.info/gems/test-kitchen/Kitchen/Verifier
+  module Verifier
+    # The verifier utilizes the {https://www.inspec.io/ InSpec infrastructure
+    # testing framework to verify the behaviour and
+    # state of resources in the Pulumi state.
+    #
+    # === Commands
+    #
+    # The following command-line commands are provided by the verifier.
+    #
+    # ==== kitchen verify
+    #
+    # A Kitchen instance is verified by iterating through the systems and
+    # running the associated InSpec controls against the hosts of each system.
+    # The outputs of the Pulumi state are retrieved and exposed as attributes
+    # to the InSpec controls.
+    #
+    # ===== Retrieving the Pulumi Output
+    #
+    #   pulumi stack output -json
+    #
+    # === Configuration Attributes
+    #
+    # The configuration attributes of the verifier control the behaviour
+    # of the InSpec runner. Within the
+    # {http://kitchen.ci/docs/getting-started/kitchen-yml .kitchen.yml},
+    # these attributes must be declared in the +verifier+ mapping along with
+    # the plugin name.
+    #
+    #   verifier:
+    #     name: pulumi
+    #     a_configuration_attribute: some value
+    #
+    # ==== color
+    #
+    # {include:Kitchen::Pulumi::ConfigAttribute::Color}
+    #
+    # ==== fail_fast
+    #
+    # {include:Kitchen::Pulumi::ConfigAttribute::FailFast}
+    #
+    # ==== systems
+    #
+    # {include:Kitchen::Pulumi::ConfigAttribute::Systems}
+    #
+    # === Ruby Interface
+    #
+    # This class implements the interface of Kitchen::Configurable which
+    # requires the following Reek suppressions:
+    # :reek:MissingSafeMethod {
+    #  exclude: [ finalize_config!, load_needed_dependencies! ]
+    # }
+    class Pulumi
+      include ::Kitchen::Configurable
+      include ::Kitchen::Logging
+      include ::Kitchen::Pulumi::ConfigAttribute::Color
+      include ::Kitchen::Pulumi::ConfigAttribute::FailFast
+      include ::Kitchen::Pulumi::ConfigAttribute::Systems
+      include ::Kitchen::Pulumi::Configurable
+      @api_version = 2
+
+      attr_reader :inputs, :outputs
+
+      def initialize(configuration = {})
+        init_config configuration
+        self.inspec_options_mapper = ::Kitchen::Pulumi::InSpecOptionsMapper.new
+        self.error_messages = []
+        self.inputs = {}
+        self.outputs = {}
+      end
+
+      # The verifier enumerates through each host of each system and verifies
+      # the associated InSpec controls.
+      #
+      # @example
+      #   `kitchen verify suite-name`
+      # @param _kitchen_state [::Hash] the mutable instance and verifier state.
+      # @raise [::Kitchen::ActionFailed] if result of the action is failure.
+      # @return [void]
+      def call(_kitchen_state)
+        load_variables
+        verify_systems
+        unless error_messages.empty?
+          raise ::Kitchen::ActionFailed, error_messages.join("\n\n")
+        end
+      rescue ::Kitchen::Pulumi::Error => e
+        raise ::Kitchen::ActionFailed, e.message
+      end
+
+      # doctor checks the system and configuration for common errors.
+      #
+      # @param _kitchen_state [::Hash] the mutable Kitchen instance state.
+      # @return [Boolean] false
+      # @see https://github.com/test-kitchen/test-kitchen/blob/v1.21.2/lib/kitchen/verifier/base.rb#L85-L91
+      def doctor(_kitchen_state)
+        false
+      end
+
+      private
+
+      attr_accessor :inspec_options_mapper, :error_messages
+      attr_writer :inputs, :outputs
+
+      def handle_error(message:)
+        raise ::Kitchen::Pulumi::Error, message if config_fail_fast
+
+        logger.error message
+        error_messages.push message
+      end
+
+      def load_variables
+        instance.driver.stack_outputs do |outputs:|
+          self.outputs.replace(outputs)
+        end
+
+        instance.driver.stack_inputs do |inputs:|
+          self.inputs.replace(inputs)
+        end
+      end
+
+      # load_needed_dependencies! loads the InSpec libraries required to verify
+      # a Pulumi stack's state.
+      #
+      # @raise [::Kitchen::ClientError] if loading the InSpec libraries fails.
+      # @see https://github.com/test-kitchen/test-kitchen/blob/v1.21.2/lib/kitchen/configurable.rb#L252-L274
+      def load_needed_dependencies!
+        require 'kitchen/pulumi/inspec'
+        require 'kitchen/pulumi/system'
+        ::Kitchen::Pulumi::InSpec.logger = logger
+      rescue ::LoadError => e
+        raise ::Kitchen::ClientError, e.message
+      end
+
+      def system_inspec_options(system:)
+        inspec_options_mapper.map(
+          options: { 'color' => config_color, 'distinct_exit' => false },
+          system: system,
+        )
+      end
+
+      def verify(system:)
+        ::Kitchen::Pulumi::System.new(
+          mapping: {
+            profile_locations: [
+              ::File.join(config.fetch(:test_base_path), instance.suite.name),
+            ],
+          }.merge(system),
+        ).verify(
+          inputs: inputs,
+          inspec_options: system_inspec_options(system: system),
+          outputs: outputs,
+        )
+      rescue StandardError => e
+        handle_error message: e.message
+      end
+
+      def verify_systems
+        config_systems.each do |system|
+          verify system: system
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,323 @@
+--- !ruby/object:Gem::Specification
+name: kitchen-pulumi
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre.beta
+platform: ruby
+authors:
+- Jacob Learned
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-06-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rspec-json_expectations
+  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: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.67'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.67'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: dry-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: dry-validation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: inspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: mixlib-shellout
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: test-kitchen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.22'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.22'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 'Kitchen-Pulumi makes it easy to add integration tests to Pulumi-based
+  infrastructure projects.
+
+  '
+email:
+- jacobmlearned@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/kitchen/driver/pulumi.rb
+- lib/kitchen/provisioner/pulumi.rb
+- lib/kitchen/pulumi.rb
+- lib/kitchen/pulumi/command.rb
+- lib/kitchen/pulumi/command/input.rb
+- lib/kitchen/pulumi/command/output.rb
+- lib/kitchen/pulumi/config_attribute.rb
+- lib/kitchen/pulumi/config_attribute/backend.rb
+- lib/kitchen/pulumi/config_attribute/color.rb
+- lib/kitchen/pulumi/config_attribute/config.rb
+- lib/kitchen/pulumi/config_attribute/config_file.rb
+- 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/refresh_config.rb
+- lib/kitchen/pulumi/config_attribute/secrets.rb
+- lib/kitchen/pulumi/config_attribute/stack.rb
+- lib/kitchen/pulumi/config_attribute/stack_evolution.rb
+- lib/kitchen/pulumi/config_attribute/systems.rb
+- lib/kitchen/pulumi/config_attribute_cacher.rb
+- lib/kitchen/pulumi/config_attribute_definer.rb
+- lib/kitchen/pulumi/config_schemas.rb
+- lib/kitchen/pulumi/config_schemas/array_of_hashes.rb
+- lib/kitchen/pulumi/config_schemas/boolean.rb
+- lib/kitchen/pulumi/config_schemas/config_evolution_array.rb
+- lib/kitchen/pulumi/config_schemas/error_messages.yml
+- lib/kitchen/pulumi/config_schemas/hash.rb
+- lib/kitchen/pulumi/config_schemas/stack_settings_hash.rb
+- lib/kitchen/pulumi/config_schemas/string.rb
+- lib/kitchen/pulumi/config_schemas/system.rb
+- lib/kitchen/pulumi/config_schemas/systems.rb
+- lib/kitchen/pulumi/configurable.rb
+- lib/kitchen/pulumi/error.rb
+- lib/kitchen/pulumi/file_path_config_attribute_definer.rb
+- lib/kitchen/pulumi/inspec.rb
+- lib/kitchen/pulumi/inspec_options_mapper.rb
+- lib/kitchen/pulumi/inspec_with_hosts.rb
+- lib/kitchen/pulumi/inspec_without_hosts.rb
+- lib/kitchen/pulumi/kitchen_instance.rb
+- lib/kitchen/pulumi/shell_out.rb
+- lib/kitchen/pulumi/system.rb
+- lib/kitchen/pulumi/system_attrs_resolver.rb
+- lib/kitchen/pulumi/system_hosts_resolver.rb
+- lib/kitchen/pulumi/version.rb
+- lib/kitchen/verifier/pulumi.rb
+homepage: https://github.com/jacoblearned/kitchen-pulumi
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Test-Kitchen plugins for Pulumi projects
+test_files: []