kitchen-static 0.9.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b67b015b3972701088feb7241ba7549dd79b96ee7267dda818d2d905166299c6
-  data.tar.gz: f10fd02e9b88ff633a31e3c4c7af06754efd475cfc0428da71a31aa88e0aa784
+  metadata.gz: 4fadfee7e8df80d6580498dc4c93c42bb7e4bf1cad8b8d71136dd03687da8a5f
+  data.tar.gz: 96d2a5be8ab420ac58d66ec1391d0edb00e4135fc9ed702c99325d1e11d1eb55
 SHA512:
-  metadata.gz: e8361c079e66845b45fb447ed64f81eb44a3e9ca399d61930c4bb4e3a541b31356d47a88c9cbf3b5b12d6c5b0f8ab6f43a5a79f1adc2c7f9506544172a31caf5
-  data.tar.gz: 848022ef54a1742687192039619356e44a1cd94c3724837b768a5fa6b7a66d4e3bd64e238181be6d06895fc26dc367f579ef02a5112688bbf132bd50dc77a8ed
+  metadata.gz: 893fb9091522ebf53e78112449f87e6134986a8b2806d05ffcf3d95567b02a7099f3bfb2587a2aaa0a013503ec17463bdf2aa298fa1b8d24764516bdc13aa7f5
+  data.tar.gz: 3762dc3b7e91d9324f3ffed0dfd7729e42a8ed8ec968cbe355181bdf446e8284cec459a1d6ad184f99194e7efff85bc0380821e4207919da00cf274258c4db2d

data/lib/kitchen/driver/queueing/base.rb

@@ -0,0 +1,87 @@
+module Kitchen::Driver
+  class Static
+    module Queueing
+      class Base
+        @options = {}
+        @request_options = {}
+        @release_options = {}
+
+        @hostname = nil
+        @banner = nil
+
+        @env_vars = {}
+
+        attr_reader :options, :request_options, :release_options, :env_vars, :banner
+
+        def initialize(options)
+          @options = {
+            queueing_timeout: 3600,
+          }
+
+          @request_options = {}
+          @release_options = {}
+
+          setup(options)
+
+          process_kitchen_options(options)
+        end
+
+        def request(state)
+          handle_request(state)
+        end
+
+        def release(state)
+          @env_vars = {
+            STATIC_HOSTNAME: state[:hostname],
+          }
+
+          handle_release(state)
+        end
+
+        def banner?
+          ! @banner.nil?
+        end
+
+        def self.descendants
+          ObjectSpace.each_object(Class).select { |klass| klass < self }
+        end
+
+        private
+
+        def setup(_options)
+          # Add setup and defaults in specific handler
+        end
+
+        def handle_request(_state)
+          raise "Implement request handler"
+        end
+
+        def handle_release(_state)
+          raise "Implement release handler"
+        end
+
+        def default_request_options(options = {})
+          @request_options.merge!(options)
+        end
+
+        def default_release_options(options = {})
+          @release_options.merge!(options)
+        end
+
+        def process_kitchen_options(kitchen_options)
+          @options = kitchen_options
+
+          @request_options.merge!(options[:request])
+          @options.delete(:request)
+
+          @release_options.merge!(options[:release])
+          @options.delete(:release)
+        end
+
+        def timeout
+          options[:queueing_timeout]
+        end
+      end
+    end
+  end
+end

data/lib/kitchen/driver/queueing/json.rb

@@ -0,0 +1,37 @@
+require_relative 'base.rb'
+
+module Kitchen::Driver
+  class Static
+    module Queueing
+      class Json < Base
+        def initialize(options = {})
+          super
+
+          default_handler_options({
+            mode:    :wait, # :wait, :repeat, ?
+            method:  :get,  # :get, :post
+            data:    '',
+            query:   {},
+            map:     {}
+          })
+
+          kitchen_handler_options options
+        end
+
+        def request
+          super
+
+          # TODO
+        end
+
+        def release
+          super
+
+          # TODO
+        end
+
+        private
+      end
+    end
+  end
+end

data/lib/kitchen/driver/queueing/script.rb

@@ -0,0 +1,49 @@
+require "mixlib/shellout"
+
+require_relative "base.rb"
+
+module Kitchen::Driver
+  class Static
+    module Queueing
+      class Script < Base
+        def setup(_kitchen_options)
+          default_request_options({
+            match_hostname: "^(.*)$",
+            match_banner: nil,
+          })
+
+          default_release_options({})
+        end
+
+        def handle_request(_state)
+          stdout = execute(request_options[:execute])
+
+          matched = stdout.match(request_options[:match_hostname])
+          raise format("Could not extract hostname from '%s' with regular expression /%s/", stdout, request_options[:match_hostname]) unless matched
+
+          # Allow additional feedback from command
+          @banner = stdout.match(request_options[:match_banner])&.captures&.first if request_options[:match_banner]
+
+          matched.captures.first
+        end
+
+        def handle_release(_state)
+          execute(release_options[:execute])
+        end
+
+        private
+
+        def execute(command)
+          raise format("Received empty command") if command.nil? || command.empty?
+
+          cmd = Mixlib::ShellOut.new(command, environment: env_vars, timeout: timeout)
+          cmd.run_command
+
+          raise format("Error executing `%s`: %s", command, cmd.stderr) if cmd.status != 0
+
+          cmd.stdout.strip
+        end
+      end
+    end
+  end
+end

data/lib/kitchen/driver/static.rb

@@ -1,4 +1,5 @@
 require "kitchen"
+
 require_relative "static_version"
 
 module Kitchen
@@ -12,16 +13,98 @@ module Kitchen
 
       plugin_version Kitchen::Driver::STATIC_VERSION
 
-      required_config :host
+      default_config :host, nil
+
+      default_config :queueing, false
+      default_config :queueing_timeout, 3600
+      default_config :queueing_handlers, []
+      default_config :request, {}
+      default_config :release, {}
+
+      BANNER_FORMAT = "[kitchen-static] >>> %s <<<".freeze
 
       def create(state)
-        state[:hostname] = config[:host]
+        print_version
+
+        state[:hostname] = queueing? ? request(state) : config[:host]
+
+        if queueing?
+          info format("[kitchen-static] Received %s for testing", state[:hostname])
+          info format(BANNER_FORMAT, queueing_handler.banner) if queueing_handler.banner?
+        end
       end
 
       def destroy(state)
+        print_version
         return if state[:hostname].nil?
+
+        release(state) if queueing?
+        info format("[kitchen-static] Released %s from testing", state[:hostname]) if queueing?
+
         state.delete(:hostname)
       end
+
+      private
+
+      def request(state)
+        info format("[kitchen-static] Queueing request via %s handler", queueing_type)
+
+        queueing_handler.request(state)
+      end
+
+      def release(state)
+        info format("[kitchen-static] Queueing release via %s handler", queueing_type)
+
+        queueing_handler.release(state)
+      end
+
+      def queueing?
+        config[:queueing] === true
+      end
+
+      def queueing_handler
+        @queueing_handler ||= queueing_registry[queueing_type].new(config)
+      end
+
+      def queueing_type
+        return unless queueing?
+
+        config.fetch(:type, "script")
+      end
+
+      def queueing_registry
+        return unless queueing?
+
+        @queueing_registry unless @queueing_registry.nil? || @queueing_registry.empty?
+        @queueing_registry = {}
+
+        bundled_handlers = File.join(__dir__, "queueing", "*.rb")
+        require_queueing_handlers(bundled_handlers)
+
+        additional_handlers = config[:queueing_handlers]
+        additional_handlers.each { |glob| require_queueing_handlers(glob) }
+
+        Queueing::Base.descendants.each do |handler_class|
+          type = queueing_type_from_class(handler_class)
+          @queueing_registry[type] = handler_class
+
+          debug format("[kitchen-static] Added queueing handler: %s", type)
+        end
+
+        @queueing_registry
+      end
+
+      def require_queueing_handlers(glob)
+        Dir.glob(glob).each { |file| require file }
+      end
+
+      def queueing_type_from_class(handler_class)
+        handler_class.to_s.split("::").last.downcase
+      end
+
+      def print_version
+        debug format("Starting kitchen-static %s", Kitchen::Driver::STATIC_VERSION)
+      end
     end
   end
 end

data/lib/kitchen/driver/static_version.rb

@@ -1,5 +1,5 @@
 module Kitchen
   module Driver
-    STATIC_VERSION = "0.9.1".freeze
+    STATIC_VERSION = "0.10.0".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-static
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.10.0
 platform: ruby
 authors:
 - Thomas Heinen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-02 00:00:00.000000000 Z
+date: 2020-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-kitchen
@@ -30,34 +30,90 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: mixlib-shellout
+  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: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.16'
+- !ruby/object:Gem::Dependency
+  name: guard-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !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'
+        version: '0.9'
 description: Test Kitchen driver for static hosts
 email:
 - theinen@tecracer.de
@@ -66,6 +122,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE
+- lib/kitchen/driver/queueing/base.rb
+- lib/kitchen/driver/queueing/json.rb
+- lib/kitchen/driver/queueing/script.rb
 - lib/kitchen/driver/static.rb
 - lib/kitchen/driver/static_version.rb
 homepage: https://github.com/tecracer-theinen/kitchen-static
@@ -87,8 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Test Kitchen driver for static hosts