kitchen-habitat 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 214fe452fd77fdc55785e5f8d14b0187f1b940bf
-  data.tar.gz: c3e5686edd119d4c16b44393992362dfe86e759f
+  metadata.gz: 1ef68d3e9be79866921be55aeadcff446de300bc
+  data.tar.gz: 99fcd6c0e79d77d273e029289b53109ac206e0fd
 SHA512:
-  metadata.gz: 323f8e9d9b496645e4bee1e533fcbd91ba866164f2f62b72b21bbddd5249e503fa5384176cd0b00961fedb3fbc4bffeebc59b748f6fc08953515eb573589a306
-  data.tar.gz: c664eb0a7b82c7303e0ba62b1d7ffc1501e40ad49d0e52ecb72c91a49bc21b9042e856292fc00004bba025d4d73c10743570df316470aa5d6f977e4d5eacd2d4
+  metadata.gz: 8e398a2ac127fb4871f49560392320c45b69f664a8f6081dcc992df3014cf33b88d343dc8dc12d72a6b705c1da8a9c69ab29dd7b8f7b9884e2181068bb2f612d
+  data.tar.gz: 7da3596810126194576dcc2dbe2a52a7ffdd1250a6e1101f6067f2cd98fde925f1c3da7b54215cf1e07989499a9e1b7ed27ba8b95cee8dd69ee8cd2c7074862e

data/README.md

@@ -19,9 +19,23 @@ You'll need the test-kitchen & kitchen-habitat gems installed in your system, al
 
 ### Supervisor Settings
 
-* `hab_sup`
+* `hab_sup_origin`
   * Package identification for the supervisor to use.
-  * Defaults to `core/hab-sup`
+  * Defaults to `core`, or, if `hab_sup_artifact_name` is supplied, the `hab_sup_origin` will be parsed from the filename of the hart file.
+* `hab_sup_name`
+  * Name of the supervisor package
+  * Defaults to `hab-sup`, or, if `hab_sup_artifact_name` is supplied, the `hab_sup_name` will be parsed from the filename of the hart file.
+* `hab_sup_version`
+  * Version number of `hab-sup` to run
+  * Defaults to `nil`, or, if `hab_sup_artifact_name` is supplied, the `hab_sup_version` will be parsed from the filename of the hart file.
+* `hab_sup_timestamp`
+  * Timestamp of the `hab-sup` package to run
+  * Defaults to `nil`, or, if `hab_sup_artifact_name` is supplied, the `hab_sup_timestamp` will be parsed from the filename of the hart file.
+* `hab_sup_artifact_name`
+  * Artifact package name for a custom supervisor to run
+  * Used to upload and test a local supervisor.
+  * Package should be located in the `results_directory` 
+  * Defaults to `nil
 * `hab_sup_listen_http`
   * Port for the supervisor's sidecar to listen on.
   * Defaults to `nil`
@@ -34,11 +48,15 @@ You'll need the test-kitchen & kitchen-habitat gems installed in your system, al
 * `artifact_name`
   * Artifact package filename to install and run.
   * Used to upload and test a local artifact.
+  * Package should be located in the `results_directory`
   * Example - `core-jq-static-1.5-20170127185151-x86_64-linux.hart`
   * Defaults to `nil`
+* `results_directory`
+  * Directory (relative to the location of the .kitchen.yml) containing package artifacts (harts) to copy to the remote system
+  * Defaults to checking the local directory for a `results` directory, then its parent (`..\results`) and grandparent (`..\..\results`), which should accomodate most studio layouts.
 * `package_origin`
   * Origin for the package to run.
-  * Defaults to `core`, or or, if `artifact_name` is supplied, the `package_origin` will be parsed from the filename of the hart file.
+  * Defaults to `core`, or, if `artifact_name` is supplied, the `package_origin` will be parsed from the filename of the hart file.
 * `package_name`
   * Package name for the supervisor to run.
   * Defaults to the suite name or, if `artifact_name` is supplied, the `package_name` will be parsed from the filename of the hart file.
@@ -48,6 +66,14 @@ You'll need the test-kitchen & kitchen-habitat gems installed in your system, al
 * `package_timestamp`
   * Package timestamp of the package to be run.
   * Defaults to `nil` or if `artifact_name` is supplied, the `package_timestamp` will be parsed from the filename of the hart file.
+* `config_directory`
+  * Directory containing a user.toml or/and a default.toml, hooks, and configuration files to be passed to the service under test.
+  * Default to `nil`
+* `override_package_config`
+  * Tell the supervisor to the the configuration files and hooks from `config_directory` instead of what was packaged with the service.  (Uses `--config-from` via the `hab-sup` CLI.)
+* `user_toml_name`
+  * Name of the file to be used as the user.toml for the service under test.
+  * Defaults to `user.toml`
 
 
 ## Example 

data/lib/kitchen-habitat/version.rb

@@ -1,5 +1,5 @@
 module Kitchen
   module Habitat
-    VERSION = "0.1.0".freeze
+    VERSION = "0.2.0".freeze
   end
 end

data/lib/kitchen/provisioner/habitat.rb

@@ -1,7 +1,7 @@
 #
 # Author:: Steven Murawski (<steven.murawski@gmail.com>)
 #
-# Copyright (C) 2014 Steven Murawski
+# Copyright (C) 2017 Steven Murawski
 #
 # Licensed under the MIT License.
 # See LICENSE for more details
@@ -17,25 +17,45 @@ module Kitchen
       kitchen_provisioner_api_version 2
 
       default_config :depot_url, nil
-      default_config :hab_sup, "core/hab-sup"
+      default_config :hab_sup_origin, "core"
+      default_config :hab_sup_name, "hab-sup"
+      default_config :hab_sup_version, nil
+      default_config :hab_sup_timestamp, nil
+      default_config :hab_sup_artifact_name, nil
 
       # hab-sup manager options
       default_config :hab_sup_listen_http, nil
       default_config :hab_sup_listen_gossip, nil
+      default_config :hab_sup_peer, []
+      default_config :hab_sup_bind, []
 
       # hab-sup service options
-      #default_config :
-      default_config :artifact_name
+      default_config :artifact_name, nil
       default_config :package_origin, "core"
       default_config :package_name do |provisioner|
         provisioner.instance.suite.name
       end
-      default_config :package_version
-      default_config :package_timestamp
+      default_config :package_version, nil
+      default_config :package_timestamp, nil
 
-      default_config :user_toml_path
+      # local stuffs to copy
+      default_config :results_directory, nil
+      default_config :config_directory, nil
+      default_config :user_toml_name, "user.toml"
+      default_config :override_package_config, false
+
+      # experimental
+      default_config :use_screen, false
 
       def finalize_config!(instance)
+        unless config[:hab_sup_artifact_name].nil?
+          ident = artifact_name_to_package_ident_regex.match(config[:hab_sup_artifact_name])
+          config[:hab_sup_origin] = ident["origin"]
+          config[:hab_sup_name] = ident["name"]
+          config[:hab_sup_version] = ident["version"]
+          config[:hab_sup_timestamp] = ident["timestamp"]
+        end
+
         unless config[:artifact_name].nil?
           ident = artifact_name_to_package_ident_regex.match(config[:artifact_name])
           config[:package_origin] = ident["origin"]
@@ -63,12 +83,13 @@ module Kitchen
       end
 
       def init_command
-        wrap_shell_code "id -u hab > /dev/null || sudo useradd hab > /dev/null"
+        wrap_shell_code "id -u hab >/dev/null 2>&1 || sudo useradd hab >/dev/null 2>&1"
       end
 
       def create_sandbox
         super
         copy_results_to_sandbox
+        copy_user_toml_to_sandbox
       end
 
       def prepare_command
@@ -77,11 +98,29 @@ module Kitchen
           #{install_supervisor_command}
           #{binlink_supervisor_command}
           #{install_service_package}
+          #{remove_previous_user_toml}
+          #{copy_user_toml_to_service_directory}
           EOH
       end
 
       def run_command
         run = <<-RUN
+        #{clean_up_screen_sessions}
+        #{export_hab_origin}
+        echo "Running #{package_ident}."
+
+        #{run_package_in_background}
+        sleep 5
+        RUN
+
+        wrap_shell_code run
+      end
+
+      private
+
+      def clean_up_screen_sessions
+        return unless config[:use_screen]
+        <<-CLEAN
         if sudo screen -ls | grep -q #{clean_package_name}
           then
             echo "Killing previous supervisor session."
@@ -89,28 +128,70 @@ module Kitchen
             echo "Removing dead session."
             sudo screen -wipe > /dev/null
         fi
-        #{export_hab_origin}
-        echo "Running #{package_ident}."
-        sudo screen -mdS \"#{clean_package_name}\" hab-sup start #{package_ident} #{supervisor_options}
-        RUN
+        CLEAN
+      end
 
-        wrap_shell_code run
+      def run_package_in_background
+        if config[:use_screen]
+          "sudo screen -mdS \"#{clean_package_name}\" hab-sup start #{package_ident} #{supervisor_options}"
+        else
+          "nohup sudo hab-sup start #{package_ident} #{supervisor_options} & echo $! > run.pid"
+        end
       end
 
-      private
+      def resolve_results_directory
+        return config[:results_directory] unless config[:results_directory].nil?
+
+        results_in_current = File.join(config[:kitchen_root], "results")
+        results_in_parent = File.join(config[:kitchen_root], "../results")
+        results_in_grandparent = File.join(config[:kitchen_root], "../../results")
+
+        if Dir.exist?(results_in_current)
+          results_in_current
+        elsif Dir.exist?(results_in_parent)
+          results_in_parent
+        elsif Dir.exist?(results_in_grandparent)
+          results_in_grandparent
+        end
+      end
 
       def copy_results_to_sandbox
+        results_dir = resolve_results_directory
+        return if results_dir.nil?
         FileUtils.mkdir_p(File.join(sandbox_path, "results"))
         FileUtils.cp_r(
-          File.join(config[:kitchen_root], "/results"),
+          results_dir,
           File.join(sandbox_path, "results"),
           preserve: true
         )
       end
 
+      def full_user_toml_path
+        File.join(File.join(config[:kitchen_root], config[:config_directory]), config[:user_toml_name])
+      end
+
+      def copy_user_toml_to_sandbox
+        return if config[:config_directory].nil?
+        FileUtils.mkdir_p(File.join(sandbox_path, "config"))
+        FileUtils.cp_r(File.join(config[:kitchen_root], config[:config_directory]), File.join(sandbox_path, "config"))
+      end
+
       def install_service_package
         return if config[:artifact_name].nil?
-        "sudo hab pkg install #{File.join(File.join(config[:root_path], "results"), config[:artifact_name])}"
+        "sudo hab pkg install #{File.join(File.join(config[:root_path], 'results'), config[:artifact_name])}"
+      end
+
+      def copy_user_toml_to_service_directory
+        return unless !config[:config_directory].nil? && File.exist?(full_user_toml_path)
+        "cp #{File.join(File.join(config[:root_path], 'config'), 'user.toml')} /hab/svc/#{config[:package_name]}/"
+      end
+
+      def remove_previous_user_toml
+        <<-REMOVE
+        if [ -d "/hab/svc/#{config[:package_name]}" ]; then
+          sudo find /hab/svc/#{config[:package_name]} -name user.toml -delete
+        fi
+        REMOVE
       end
 
       def export_hab_origin
@@ -119,17 +200,25 @@ module Kitchen
       end
 
       def install_supervisor_command
-        "sudo hab pkg install #{config[:hab_sup]}"
+        "sudo hab pkg install #{hab_sup_ident}"
       end
 
       def binlink_supervisor_command
-        "sudo hab pkg binlink #{config[:hab_sup]} hab-sup"
+        "sudo hab pkg binlink #{hab_sup_ident} hab-sup"
       end
 
       def artifact_name_to_package_ident_regex
         /(?<origin>\w+)-(?<name>.*)-(?<version>(\d+)?(\.\d+)?(\.\d+)?(\.\d+)?)-(?<timestamp>\d+)-(?<target>.*)\.hart$/
       end
 
+      def hab_sup_ident
+        ident = "#{config[:hab_sup_origin]}/" \
+                "#{config[:hab_sup_name]}/" \
+                "#{config[:hab_sup_version]}/" \
+                "#{config[:hab_sup_timestamp]}".chomp("/").chomp("/")
+        @sup_ident ||= ident
+      end
+
       def package_ident
         ident = "#{config[:package_origin]}/" \
                 "#{config[:package_name]}/" \
@@ -143,10 +232,13 @@ module Kitchen
       end
 
       def supervisor_options
-        options = "#{'--listen-gossip' + config[:hab_sup_listen_gossip] unless config[:hab_sup_listen_gossip].nil?} "  \
-        "#{'--listen-http' + config[:hab_sup_listen_http] unless config[:hab_sup_listen_http].nil?} "  \
-        ""
-        options.strip
+        options = "#{'--listen-gossip ' + config[:hab_sup_listen_gossip] unless config[:hab_sup_listen_gossip].nil?} "  \
+        "#{'--listen-http ' + config[:hab_sup_listen_http] unless config[:hab_sup_listen_http].nil?} "  \
+        "#{'--config-from ' + File.join(config[:root_path], 'config/') if config[:override_package_config]} "
+        options.strip!
+        options += config[:hab_sup_bind].map { |b| "--bind #{b}" }.join(" ") if config[:hab_sup_bind].any?
+        options += config[:hab_sup_peer].map { |p| "--peer #{p}" }.join(" ") if config[:hab_sup_peer].any?
+        options
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-habitat
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Steven Murawski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-02 00:00:00.000000000 Z
+date: 2017-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-kitchen