kitchen-pulumi 0.1.0.pre.beta

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 364ba19dd3c354faa5da8dced15d5a512ddd5632049a7b833ae9be70988986cc
+  data.tar.gz: 38b0bde440532a316ffeaf1da6fba1556a071d5b3021ed3e10adc90447325862
+SHA512:
+  metadata.gz: 1ddea6c299dfe2537cf3b356af371415bebd01b134abf5f5d7a5ae053fea66f7975fa400914f53d8d8074a571a394829ff3524bc259feed9d9ea0722d3aafa0b
+  data.tar.gz: 362722b88d15305c290f580c3f5363e3b61d1b84bd084ec88dbe59d345111d50151d64e295b585bfc5916fcb33307f8e3033cb0c12f290490644601edca09e56

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 jacoblearned
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,4 @@
+[![CircleCI](https://circleci.com/gh/jacoblearned/kitchen-pulumi/tree/master.svg?style=shield)](https://circleci.com/gh/jacoblearned/kitchen-pulumi/tree/master)
+
+# kitchen-pulumi
+Test-Kitchen plugins for Pulumi projects

data/lib/kitchen/driver/pulumi.rb

@@ -0,0 +1,170 @@
+# frozen_string_literal: true
+
+require 'kitchen'
+require 'kitchen/driver/base'
+require 'kitchen/pulumi/error'
+require 'kitchen/pulumi/shell_out'
+require 'kitchen/pulumi/configurable'
+require 'kitchen/pulumi/command/input'
+require 'kitchen/pulumi/command/output'
+require 'kitchen/pulumi/config_attribute/config'
+require 'kitchen/pulumi/config_attribute/config_file'
+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/stack_evolution'
+require 'kitchen/pulumi/config_attribute/refresh_config'
+
+module Kitchen
+  module Driver
+    # Driver class implementing the CLI equivalency between Kitchen and Pulumi
+    class Pulumi < ::Kitchen::Driver::Base
+      kitchen_driver_api_version 2
+
+      include ::Kitchen::Pulumi::Configurable
+
+      # Include config attributes consumable via .kitchen.yml
+      include ::Kitchen::Pulumi::ConfigAttribute::Config
+      include ::Kitchen::Pulumi::ConfigAttribute::ConfigFile
+      include ::Kitchen::Pulumi::ConfigAttribute::Directory
+      include ::Kitchen::Pulumi::ConfigAttribute::Plugins
+      include ::Kitchen::Pulumi::ConfigAttribute::Backend
+      include ::Kitchen::Pulumi::ConfigAttribute::Secrets
+      include ::Kitchen::Pulumi::ConfigAttribute::Stack
+      include ::Kitchen::Pulumi::ConfigAttribute::StackEvolution
+      include ::Kitchen::Pulumi::ConfigAttribute::RefreshConfig
+
+      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)
+        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?
+      end
+
+      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}",
+        ]
+
+        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/)
+      end
+
+      def login
+        backend = config_backend == 'local' ? '--local' : config_backend
+        ::Kitchen::Pulumi::ShellOut.run(
+          cmd: "login #{backend}",
+          logger: logger,
+        )
+      end
+
+      def initialize_stack(stack, dir = '')
+        ::Kitchen::Pulumi::ShellOut.run(
+          cmd: "stack init #{stack} #{dir}",
+          logger: logger,
+        )
+      rescue ::Kitchen::Pulumi::Error => e
+        puts 'Continuing...' if e.message.match?(/stack '#{stack}' already exists/)
+      end
+
+      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}"
+
+        stack_confs.each do |namespace, stack_settings|
+          stack_settings.each do |key, val|
+            ::Kitchen::Pulumi::ShellOut.run(
+              cmd: "#{base_cmd} #{namespace}:#{key} \"#{val}\"",
+              logger: logger,
+            )
+          end
+        end
+      end
+
+      def refresh_config(stack, conf_file, dir = '')
+        ::Kitchen::Pulumi::ShellOut.run(
+          cmd: "config refresh -s #{stack} #{dir} #{conf_file}",
+          logger: logger,
+        )
+      rescue ::Kitchen::Pulumi::Error => e
+        puts 'Continuing...' if e.message.match?(/no previous deployment/)
+      end
+
+      def config_file(conf_file = '')
+        file = conf_file.empty? ? config_config_file : conf_file
+        return '' if File.directory?(file) || file.empty?
+
+        "--config-file #{file}"
+      end
+
+      def update_stack(stack, conf_file, dir = '')
+        ::Kitchen::Pulumi::ShellOut.run(
+          cmd: "up -y -r --show-config -s #{stack} #{dir} #{conf_file}",
+          logger: logger,
+        )
+      end
+
+      def evolve_stack(stack, dir = '')
+        config_stack_evolution.each do |evolution|
+          conf_file = config_file(evolution.fetch(:config_file, ''))
+          new_stack_confs = evolution.fetch(:config, {})
+          new_stack_secrets = evolution.fetch(:secrets, {})
+
+          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)
+        end
+      end
+
+      def stack_inputs(&block)
+        ::Kitchen::Pulumi::Command::Input.run(
+          directory: config_directory,
+          stack: config_stack,
+          conf_file: config_file,
+          logger: logger,
+          &block
+        )
+
+        self
+      rescue ::Kitchen::Pulumi::Error => e
+        raise ::Kitchen::ActionFailed, e.message
+      end
+
+      def stack_outputs(&block)
+        ::Kitchen::Pulumi::Command::Output.run(
+          directory: config_directory,
+          stack: config_stack,
+          logger: logger,
+          &block
+        )
+
+        self
+      rescue ::Kitchen::Pulumi::Error => e
+        raise ::Kitchen::ActionFailed, e.message
+      end
+    end
+  end
+end

data/lib/kitchen/provisioner/pulumi.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'kitchen'
+require 'kitchen/provisioner/base'
+require 'kitchen/pulumi/configurable'
+
+module Kitchen
+  module Provisioner
+    # Driver class whose call method is invoked when users
+    # run kitchen converge
+    class Pulumi < ::Kitchen::Provisioner::Base
+      kitchen_provisioner_api_version 2
+
+      include ::Kitchen::Pulumi::Configurable
+
+      # Runs stack updates via the instance driver
+      def call(state)
+        instance.driver.update(state)
+      rescue ::Kitchen::Pulumi::Error => e
+        raise(::Kitchen::ActionFailed, e.message)
+      end
+    end
+  end
+end

data/lib/kitchen/pulumi.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Global kitchen module
+module Kitchen
+  # Namespace for Kitchen-Pulumi logic
+  module Pulumi
+  end
+end

data/lib/kitchen/pulumi/command.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'kitchen/pulumi'
+
+module Kitchen
+  module Pulumi
+    # The namespace for Pulumi commands.
+    module Command
+    end
+  end
+end

data/lib/kitchen/pulumi/command/input.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'kitchen'
+require 'kitchen/pulumi/command'
+require 'kitchen/pulumi/error'
+require 'kitchen/pulumi/shell_out'
+
+module Kitchen
+  module Pulumi
+    module Command
+      # Class used to fetch resolved stack inputs via '$ pulumi config --json'
+      module Input
+        class << self
+          def run(directory:, stack:, conf_file:, logger:)
+            cmd = "config -C #{directory} -s #{stack} #{conf_file} -j"
+
+            ::Kitchen::Pulumi::ShellOut.run(cmd: cmd, logger: logger) do |stdout:|
+              yield inputs: ::Kitchen::Util.stringified_hash(
+                ::JSON.parse(stdout),
+              )
+            end
+          rescue ::JSON::ParserError => e
+            raise(
+              ::Kitchen::Pulumi::Error,
+              "Parsing resolved stack config as JSON failed: #{e.message}",
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kitchen/pulumi/command/output.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'kitchen'
+require 'kitchen/pulumi/command'
+require 'kitchen/pulumi/error'
+require 'kitchen/pulumi/shell_out'
+
+module Kitchen
+  module Pulumi
+    module Command
+      # Class used to fetch stack outputs via '$ pulumi stack output --json'
+      module Output
+        class << self
+          def run(directory:, stack:, logger:)
+            cmd = "stack -C #{directory} -s #{stack} output -j"
+
+            ::Kitchen::Pulumi::ShellOut.run(cmd: cmd, logger: logger) do |stdout:|
+              yield outputs: ::Kitchen::Util.stringified_hash(
+                ::JSON.parse(stdout),
+              )
+            end
+          rescue ::JSON::ParserError => e
+            raise(
+              ::Kitchen::Pulumi::Error,
+              "Parsing Pulumi stack output as JSON failed: #{e.message}",
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kitchen/pulumi/config_attribute.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'kitchen/pulumi'
+
+module Kitchen
+  module Pulumi
+    # Namespace for config attributes that are set by the user in
+    # .kitchen.yml and used within Test Kitchen plugins that include them.
+    module ConfigAttribute
+    end
+  end
+end

data/lib/kitchen/pulumi/config_attribute/backend.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 specify the Pulumi backend to use.
+      # It contains the URL to the backend, local or remote
+      module Backend
+        def self.included(plugin_class)
+          definer = ConfigAttributeDefiner.new(
+            attribute: self,
+            schema: ConfigSchemas::String,
+          )
+          definer.define(plugin_class: plugin_class)
+        end
+
+        def self.to_sym
+          :backend
+        end
+
+        extend ConfigAttributeCacher
+
+        def config_backend_default_value
+          ''
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'kitchen'
+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 to toggle colored output from systems invoked by the plugin
+      module Color
+        def self.included(plugin_class)
+          definer = ConfigAttributeDefiner.new(
+            attribute: self,
+            schema: ConfigSchemas::Boolean,
+          )
+          definer.define(plugin_class: plugin_class)
+        end
+
+        def self.to_sym
+          :color
+        end
+
+        extend ConfigAttributeCacher
+
+        def config_color_default_value
+          ::Kitchen.tty?
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'kitchen/pulumi/config_attribute'
+require 'kitchen/pulumi/config_schemas/stack_settings_hash'
+require 'kitchen/pulumi/config_attribute_cacher'
+require 'kitchen/pulumi/config_attribute_definer'
+
+module Kitchen
+  module Pulumi
+    module ConfigAttribute
+      # Module used for the 'config' instance var on an
+      # instance driver. The driver will set the Pulumi stack
+      # configs for each of the namespaces provided.
+      module Config
+        def self.included(plugin)
+          definer = ConfigAttributeDefiner.new(
+            attribute: self,
+            schema: ConfigSchemas::StackSettingsHash,
+          )
+          definer.define(plugin_class: plugin)
+        end
+
+        def self.to_sym
+          :config
+        end
+
+        extend ConfigAttributeCacher
+
+        def config_config_default_value
+          {}
+        end
+      end
+    end
+  end
+end

data/lib/kitchen/pulumi/config_attribute/config_file.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/file_path_config_attribute_definer'
+
+module Kitchen
+  module Pulumi
+    module ConfigAttribute
+      # Attribute used to specify the config_file containing a project's
+      # stack configuration
+      module ConfigFile
+        def self.included(plugin_class)
+          definer = FilePathConfigAttributeDefiner.new(
+            attribute: self,
+            schema: ConfigSchemas::String,
+          )
+          definer.define(plugin_class: plugin_class)
+        end
+
+        def self.to_sym
+          :config_file
+        end
+
+        extend ConfigAttributeCacher
+
+        def config_config_file_default_value
+          ''
+        end
+      end
+    end
+  end
+end